From 20582e90d25ef31f902a26ee41175f78555ed179 Mon Sep 17 00:00:00 2001 From: timelyportfolio Date: Sun, 1 Oct 2023 21:33:35 -0500 Subject: [PATCH] roxygenize and pkgdown build site --- DESCRIPTION | 2 +- docs/404.html | 129 ++++++++---------------- docs/CONDUCT.html | 121 ++++------------------ docs/LICENSE-text.html | 119 ++++------------------ docs/authors.html | 175 +++++++++++--------------------- docs/index.html | 204 +++++++++++++++++++------------------- docs/pkgdown.css | 87 +++++++++------- docs/pkgdown.js | 4 +- docs/pkgdown.yml | 6 +- docs/reference/index.html | 188 +++++++---------------------------- 10 files changed, 341 insertions(+), 694 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 5de833b..79d5749 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -46,5 +46,5 @@ Suggests: knitr, usethis, jsonlite -RoxygenNote: 7.1.1 +RoxygenNote: 7.2.3 VignetteBuilder: knitr diff --git a/docs/404.html b/docs/404.html index becafbf..3c5f7d1 100644 --- a/docs/404.html +++ b/docs/404.html @@ -1,69 +1,33 @@ - - - - + + + + - Page not found (404) • reactR - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + - - - - -
-
- + +
+ + + - - -
+

Page not found (404)

@@ -140,31 +97,31 @@

Page not found (404)

+
-
-
-

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

+
+

+

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

-

Site built with pkgdown 1.5.1.

+

+

Site built with pkgdown 2.0.7.

-
+
+ + - - diff --git a/docs/CONDUCT.html b/docs/CONDUCT.html index 303102b..5ee2983 100644 --- a/docs/CONDUCT.html +++ b/docs/CONDUCT.html @@ -1,69 +1,12 @@ - - - - - - - -Contributor Code of Conduct • reactR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Contributor Code of Conduct • reactR + + - - - - -
-
- -
- -
+

Contributor Code of Conduct

@@ -142,37 +69,33 @@

Contributor Code of Conduct

Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.

-

This Code of Conduct is adapted from the Contributor Covenant (http:contributor-covenant.org), version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/

+

This Code of Conduct is adapted from the Contributor Covenant (http:contributor-covenant.org), version 1.0.0, available at http://contributor-covenant.org/version/1/0/0/

+
-
-
-

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

+
+

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

-

Site built with pkgdown 1.5.1.

+

Site built with pkgdown 2.0.7.

-
-
+
- - + + diff --git a/docs/LICENSE-text.html b/docs/LICENSE-text.html index e47d2e4..b1b4ce5 100644 --- a/docs/LICENSE-text.html +++ b/docs/LICENSE-text.html @@ -1,69 +1,12 @@ - - - - - - - -License • reactR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -License • reactR + + - - - - -
-
- -
- -
+

License

@@ -142,31 +69,27 @@

License

+
-
-
-

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

+
+

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

-

Site built with pkgdown 1.5.1.

+

Site built with pkgdown 2.0.7.

-
-
+
- - + + diff --git a/docs/authors.html b/docs/authors.html index 77aabe7..48a9e04 100644 --- a/docs/authors.html +++ b/docs/authors.html @@ -1,69 +1,12 @@ - - - - - - - -Authors • reactR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Authors and Citation • reactR + + - - - - - -
-
-
- -
+
-
-

Authors

+
+
+

Authors

+
+ + +
  • +

    Facebook Inc. Author, copyright holder. +
    React library in lib, https://reactjs.org/; see AUTHORS for full list of contributors

    +
    • +
  • +

    Michel Weststrate. Author, copyright holder. +
    mobx library in lib, https://github.com/mobxjs

    +
    • +
  • +

    Kent Russell. Author, maintainer. +
    R interface

    +
    • +
  • +

    Alan Dipert. Author. +
    R interface

    +
    • +
+
+
+

Citation

+ Source: DESCRIPTION +
-
    -
  • -

    Facebook Inc. Author, copyright holder. -
    React library in lib, https://reactjs.org/; see AUTHORS for full list of contributors

    -
    • -
  • -

    Michel Weststrate. Author, copyright holder. -
    mobx library in lib, https://github.com/mobxjs

    -
    • -
  • -

    Kent Russell. Author, maintainer. -
    R interface

    -
    • -
  • -

    Alan Dipert. Author. -
    R interface

    -
    • -
+ +

Inc F, Weststrate M, Russell K, Dipert A (2023). +reactR: React Helpers. +R package version 0.5.0, https://github.com/react-R/reactR. +

+ 
@Manual{,
+  title = {reactR: React Helpers},
+  author = {Facebook Inc and Michel Weststrate and Kent Russell and Alan Dipert},
+  year = {2023},
+  note = {R package version 0.5.0},
+  url = {https://github.com/react-R/reactR},
+}
@@ -160,22 +107,20 @@

Authors

-
-
-

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

+
+

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

-

Site built with pkgdown 1.5.1.

+

Site built with pkgdown 2.0.7.

-
-
+
- - + + diff --git a/docs/index.html b/docs/index.html index d7e0853..7c41b31 100644 --- a/docs/index.html +++ b/docs/index.html @@ -27,6 +27,8 @@ + +
-
-

-reactR reactR logo +
+

reactR reactR logo

- -

reactR provides a set of convenience functions for using React in R with htmlwidget constructor templates and local JavaScript dependencies. The React ecosystem is rich with components that can enhance R web and Shiny apps. scaffoldReactWidget() helps build htmlwidgets to integrate these React components as R htmlwidgets. scaffoldReactShinyInput() does the same for Shiny inputs. The local dependency functions are modeled after the html_dependency_* functions from RStudio’s rmarkdown package.

-
-

-Installation

-

You can install reactR from CRAN with install.packages("reactR"). For the development version, please use devtools as shown below.

-
# install.packages("devtools")
-devtools::install_github("react-R/reactR")
-
-
-

-Creating htmlwidgets with React Components

-

To wrap a React component as an htmlwidget, please see the tutorial htmlwidgets with reactR. Also, there are a variety of examples in the react-R Github organization.

-

reactable is a very well-built htmlwidget leveraging this functionality.

-
-
-

-Shiny Outputs and Inputs

-

htmlwidgets built with reactR work well in Shiny as outputs. In version 0.4.0 Alan Dipert has added the ability to easily create React-based official Shiny inputs with helpers and scaffolds. Please see the tutorial for more details.

-
-
-

-Examples

+

CRAN_Status_Badge R-CMD-check

+

reactR provides a set of convenience functions for using React in R with htmlwidget constructor templates and local JavaScript dependencies. The React ecosystem is rich with components that can enhance R web and Shiny apps. scaffoldReactWidget() helps build htmlwidgets to integrate these React components as R htmlwidgets. scaffoldReactShinyInput() does the same for Shiny inputs. The local dependency functions are modeled after the html_dependency_* functions from RStudio’s rmarkdown package.

+
+

Installation +

+

You can install reactR from CRAN with install.packages("reactR"). For the development version, please use devtools as shown below.

+
+# install.packages("devtools")
+devtools::install_github("react-R/reactR")
+
+
+

Creating htmlwidgets with React Components +

+

To wrap a React component as an htmlwidget, please see the tutorial htmlwidgets with reactR. Also, there are a variety of examples in the react-R Github organization.

+

reactable is a very well-built htmlwidget leveraging this functionality.

+
+
+

Shiny Outputs and Inputs +

+

htmlwidgets built with reactR work well in Shiny as outputs. In version 0.4.0 Alan Dipert has added the ability to easily create React-based official Shiny inputs with helpers and scaffolds. Please see the tutorial for more details.

+
+
+

Examples +

Below are examples of using reactR directly.

-
library(reactR)
-library(htmltools)
-
-browsable(tagList(
-  tags$div(id = "app"),
-  tags$script(
-  "
-    ReactDOM.render(
-      React.createElement(
-        'h1',
-        null,
-        'Powered by React'
-      ),
-      document.getElementById('app')
-    )
-  "
-  ),
-  #add core-js first to work in RStudio Viewer
-  html_dependency_corejs(),
-  html_dependency_react()
-))
+
+library(reactR)
+library(htmltools)
+
+browsable(tagList(
+  tags$div(id = "app"),
+  tags$script(
+  "
+    ReactDOM.render(
+      React.createElement(
+        'h1',
+        null,
+        'Powered by React'
+      ),
+      document.getElementById('app')
+    )
+  "
+  ),
+  #add core-js first to work in RStudio Viewer
+  html_dependency_corejs(),
+  html_dependency_react()
+))

reactR uses the V8 package if available to transform JSX and ES2015 code with babel.

-
library(reactR)
-library(htmltools)
-
-browsable(
-  tagList(
-    tags$div(id = "app"),
-    tags$script(
-      babel_transform('ReactDOM.render(<h1>Powered By React/JSX</h1>,document.getElementById("app"))')
-    ),
-    # add core-js shim first for React in older versions of RStudio Viewer
-    #html_dependency_corejs(),
-    html_dependency_react()
-  )
-)
-
-
-

-Contributing and Code of Conduct

-

We welcome contributors and would love your participation. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by the terms.

+
+library(reactR)
+library(htmltools)
+
+browsable(
+  tagList(
+    tags$div(id = "app"),
+    tags$script(
+      babel_transform('ReactDOM.render(<h1>Powered By React/JSX</h1>,document.getElementById("app"))')
+    ),
+    # add core-js shim first for React in older versions of RStudio Viewer
+    #html_dependency_corejs(),
+    html_dependency_react()
+  )
+)
+
+
+

Contributing and Code of Conduct +

+

We welcome contributors and would love your participation. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by the terms.

-

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

+

+

Developed by Facebook Inc, Michel Weststrate, Kent Russell, Alan Dipert.

-

Site built with pkgdown 1.5.1.

+

+

Site built with pkgdown 2.0.7.

@@ -229,5 +227,7 @@

Dev status

+ + diff --git a/docs/pkgdown.css b/docs/pkgdown.css index c01e592..80ea5b8 100644 --- a/docs/pkgdown.css +++ b/docs/pkgdown.css @@ -56,8 +56,10 @@ img.icon { float: right; } -img { +/* Ensure in-page images don't run outside their container */ +.contents img { max-width: 100%; + height: auto; } /* Fix bug in bootstrap (only seen in firefox) */ @@ -78,11 +80,10 @@ dd { /* Section anchors ---------------------------------*/ a.anchor { - margin-left: -30px; - display:inline-block; - width: 30px; - height: 30px; - visibility: hidden; + display: none; + margin-left: 5px; + width: 20px; + height: 20px; background-image: url(./link.svg); background-repeat: no-repeat; @@ -90,17 +91,15 @@ a.anchor { background-position: center center; } -.hasAnchor:hover a.anchor { - visibility: visible; -} - -@media (max-width: 767px) { - .hasAnchor:hover a.anchor { - visibility: hidden; - } +h1:hover .anchor, +h2:hover .anchor, +h3:hover .anchor, +h4:hover .anchor, +h5:hover .anchor, +h6:hover .anchor { + display: inline-block; } - /* Fixes for fixed navbar --------------------------*/ .contents h1, .contents h2, .contents h3, .contents h4 { @@ -244,14 +243,14 @@ nav[data-toggle='toc'] .nav .nav > .active:focus > a { .ref-index th {font-weight: normal;} -.ref-index td {vertical-align: top;} +.ref-index td {vertical-align: top; min-width: 100px} .ref-index .icon {width: 40px;} .ref-index .alias {width: 40%;} .ref-index-icons .alias {width: calc(40% - 40px);} .ref-index .title {width: 60%;} .ref-arguments th {text-align: right; padding-right: 10px;} -.ref-arguments th, .ref-arguments td {vertical-align: top;} +.ref-arguments th, .ref-arguments td {vertical-align: top; min-width: 100px} .ref-arguments .name {width: 20%;} .ref-arguments .desc {width: 80%;} @@ -264,31 +263,26 @@ table { /* Syntax highlighting ---------------------------------------------------- */ -pre { - word-wrap: normal; - word-break: normal; - border: 1px solid #eee; -} - -pre, code { +pre, code, pre code { background-color: #f8f8f8; color: #333; } +pre, pre code { + white-space: pre-wrap; + word-break: break-all; + overflow-wrap: break-word; +} -pre code { - overflow: auto; - word-wrap: normal; - white-space: pre; +pre { + border: 1px solid #eee; } -pre .img { +pre .img, pre .r-plt { margin: 5px 0; } -pre .img img { +pre .img img, pre .r-plt img { background-color: #fff; - display: block; - height: auto; } code a, pre a { @@ -305,9 +299,8 @@ a.sourceLine:hover { .kw {color: #264D66;} /* keyword */ .co {color: #888888;} /* comment */ -.message { color: black; font-weight: bolder;} -.error { color: orange; font-weight: bolder;} -.warning { color: #6A0366; font-weight: bolder;} +.error {font-weight: bolder;} +.warning {font-weight: bolder;} /* Clipboard --------------------------*/ @@ -365,3 +358,27 @@ mark { content: ""; } } + +/* Section anchors --------------------------------- + Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 +*/ + +div.csl-bib-body { } +div.csl-entry { + clear: both; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} diff --git a/docs/pkgdown.js b/docs/pkgdown.js index 7e7048f..6f0eee4 100644 --- a/docs/pkgdown.js +++ b/docs/pkgdown.js @@ -80,7 +80,7 @@ $(document).ready(function() { var copyButton = ""; - $(".examples, div.sourceCode").addClass("hasCopyButton"); + $("div.sourceCode").addClass("hasCopyButton"); // Insert copy buttons: $(copyButton).prependTo(".hasCopyButton"); @@ -91,7 +91,7 @@ // Initialize clipboard: var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { - return trigger.parentNode.textContent; + return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); } }); diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index 5336656..3842e70 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -1,9 +1,9 @@ -pandoc: 2.7.3 -pkgdown: 1.5.1 +pandoc: 3.1.8 +pkgdown: 2.0.7 pkgdown_sha: ~ articles: intro_htmlwidgets: intro_htmlwidgets.html intro_inputs: intro_inputs.html intro_reactR: intro_reactR.html -last_built: 2021-02-22T13:51Z +last_built: 2023-10-02T02:32Z diff --git a/docs/reference/index.html b/docs/reference/index.html index 0de56bd..8f55bf3 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,69 +1,12 @@ - - - - - - - -Function reference • reactR - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Function reference • reactR - - - - + + -
-
- -
- -
+

Reference

- - - - - - - - - - -
-

All functions

+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+

All functions

+

babel_transform()

Transform Code with Babel

+

component()

Create a React component

+

createReactShinyInput()

Create a React-based input

+

html_dependency_corejs()

Shim Dependency for React in RStudio Viewer

+

html_dependency_mobx()

Dependencies for 'mobx'

+

html_dependency_react()

Dependencies for React

+

html_dependency_reacttools()

Adds window.reactR.exposeComponents and window.reactR.hydrate

+

React

React component builder.

+

reactMarkup()

Prepare data that represents a single-element character vector, a React component, or an htmltools tag for sending to the client.

+

scaffoldReactShinyInput()

Create implementation scaffolding for a React.js-based Shiny input.

+

scaffoldReactWidget()

Create implementation scaffolding for a React.js-based HTML widget

- +
+
-
- - + +