diff --git a/.Rbuildignore b/.Rbuildignore index 73f344d..d4b097c 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -36,3 +36,4 @@ ^\.github$ ^logo ^pkgdown$ +^revdep$ diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md index 10b1f00..f8ece70 100644 --- a/.github/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,4 +1,4 @@ -Please briefly describe your problem and what output you expect. If you have a question, please try using the [RStudio Community website](https://community.rstudio.com/c/shiny) first. +Please briefly describe your problem and what output you expect. If you have a question, please try using the [RStudio Community website](https://community.rstudio.com/c/shiny/8) first. Please include a minimal reprex. The goal of a reprex is to make it as easy as possible for me to recreate your problem so that I can fix it. If you've never heard of a reprex before, start by reading , and follow the advice further down the page. Do NOT include session info unless it's explicitly asked for, or you've used `reprex::reprex(..., si = TRUE)` to hide it away. diff --git a/DESCRIPTION b/DESCRIPTION index 55a4e8e..f5a284d 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: reactlog Title: Reactivity Visualizer for 'shiny' -Version: 1.0.0.9000 +Version: 1.1.0 Authors@R: c( person( "Barret", "Schloerke", email = "barret@rstudio.com", role = c("aut", "cre"), diff --git a/NEWS.md b/NEWS.md index b670945..13318bd 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -reactlog 1.0.0.9000 +reactlog 1.1.0 ========================== - Added a shiny module to inline the current `reactlog`. See `?reactlog_module_ui` for an example (#66) diff --git a/R/setReactLog.R b/R/setReactLog.R index 80c5525..de6c27c 100644 --- a/R/setReactLog.R +++ b/R/setReactLog.R @@ -15,7 +15,7 @@ reactlog_enable <- function() { #' @export #' @rdname setReactLog reactlog_disable <- function(warn = TRUE) { - if (!isTRUE(warn) && !isFALSE(warn)) { + if (!isTRUE(warn) && !identical(warn, FALSE)) { stop("'warn' must be either 'TRUE' or 'FALSE'") } diff --git a/R/shinyModule.R b/R/shinyModule.R index c8d7697..704898d 100644 --- a/R/shinyModule.R +++ b/R/shinyModule.R @@ -11,7 +11,7 @@ #' @param id \pkg{shiny} module id to use #' @param ... parameters passed to [shiny::actionButton()] #' @param width,height HTML attributes to be applied to the reactlog iframe -#' @param include_refresh should the ifram refresh button be included? +#' @param include_refresh should the iframe refresh button be included? #' @seealso [shiny::moduleServer()] #' @rdname reactlog_module #' @export diff --git a/README.md b/README.md index 7446f4c..90eb6d9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# reactlog +# reactlog [![R build status](https://github.com/rstudio/reactlog/workflows/R-CMD-check/badge.svg)](https://github.com/rstudio/reactlog/actions) @@ -14,7 +14,7 @@ -[Shiny](http://shiny.rstudio.com/) is an R package from RStudio that makes it incredibly easy to build interactive web applications with R. Behind the scenes, Shiny builds a reactive graph that can quickly become intertwined and difficult to debug. **reactlog** provides a visual insight into that _black box_ of Shiny reactivity. +[Shiny](https://shiny.rstudio.com/) is an R package from RStudio that makes it incredibly easy to build interactive web applications with R. Behind the scenes, Shiny builds a reactive graph that can quickly become intertwined and difficult to debug. **reactlog** provides a visual insight into that _black box_ of Shiny reactivity. After logging the reactive interactions of a Shiny application, **reactlog** constructs a directed dependency graph of the Shiny's reactive state at any time point in the record. The **reactlog** dependency graph provides users with the ability to visually see if reactive elements are: * Not utilized (never retrieved) @@ -23,7 +23,7 @@ After logging the reactive interactions of a Shiny application, **reactlog** con * Invalidating all expected dependencies * Freezing (and thawing), preventing triggering of future reactivity - + ## Major Features @@ -88,24 +88,24 @@ For more examples and explanation, see the [**reactlog** vignette](https://rstud ## Community Support -The best place to get help with Shiny and **reactlog** is [RStudio Community](https://community.rstudio.com/c/shiny). +The best place to get help with Shiny and **reactlog** is [RStudio Community](https://community.rstudio.com/c/shiny/8). If you're having difficulties with **reactlog**, feel free to [ask questions here](https://community.rstudio.com/new-topic?title=&category_id=8&tags=reactlog&body=%0A%0A%0A%20%20--------%0A%20%20%0A%20%20%3Csup%3EReferred%20here%20by%20%60reactlog%60%27s%20README%3C/sup%3E%0A&u=barret). For bug reports, please use the **reactlog** [issue tracker](https://github.com/rstudio/reactlog/issues). ## Development -[![node version: 11.x](https://img.shields.io/badge/node-11.x-brightgreen.svg)](https://nodejs.org/en/) -[![yarn version: 1.13.0](https://img.shields.io/badge/yarn-1.13.0-257bac.svg)](https://yarnpkg.com/en/) +[![node version: 12.x](https://img.shields.io/badge/node-12.x-brightgreen.svg)](https://nodejs.org/en/) +[![yarn version: 1.x](https://img.shields.io/badge/yarn-1.x-257bac.svg)](https://classic.yarnpkg.com/lang/en/) [![JavaScript type: flow](https://img.shields.io/npm/types/flow-typed.svg)](https://github.com/flow-typed/flow-typed) -[![cytoscape version: 1.13.0](https://img.shields.io/github/package-json/dependency-version/rstudio/reactlog/cytoscape.svg)](http://js.cytoscape.org/) +[![cytoscape](https://img.shields.io/github/package-json/dependency-version/rstudio/reactlog/cytoscape.svg)](https://js.cytoscape.org/) [![@babel/preset-env](https://img.shields.io/github/package-json/dependency-version/rstudio/reactlog/dev/@babel/preset-env.svg)](https://babeljs.io/) [![webpack](https://img.shields.io/github/package-json/dependency-version/rstudio/reactlog/dev/webpack.svg)](https://webpack.js.org/) [![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier) [![linter: eslint](https://img.shields.io/badge/linter-eslint-3524ca.svg)](https://eslint.org/) -Please make sure you have [GitHub Large File Storage](https://git-lfs.github.com/), [Node.js](https://nodejs.org/en/) and [yarn](https://yarnpkg.com/en/docs/install) installed. +Please make sure you have [GitHub Large File Storage](https://git-lfs.github.com/), [Node.js](https://nodejs.org/en/) and [yarn](https://classic.yarnpkg.com/en/docs/install) installed. Installation script: @@ -121,10 +121,3 @@ yarn watch ``` By changing the file `'./inst/reactlog/defaultLog.js'` with the contents of any log file in `'./inst/log-files/'`, different default log files can be loaded. Once the local JavaScript (`'./inst/reactlog/reactlogAsset/reactlog.js'`) has been built with `yarn build` or `yarn watch`, refresh `'./inst/reactlog/reactlog.html'` to avoid constantly spawning Shiny applications for testing. - - -## Guidelines for contributing - -We welcome contributions to the **reactlog** package. Please see our [CONTRIBUTING.md](.github/CONTRIBUTING.md) file for detailed guidelines of how to contribute. - -Please note that the **reactlog** project is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md). By contributing to this project, you agree to abide by its terms. diff --git a/cran-comments.md b/cran-comments.md index 058c09c..9232f4f 100644 --- a/cran-comments.md +++ b/cran-comments.md @@ -1,99 +1,53 @@ -## Cran comments +## CRAN comments -#### 2019-3-18 +#### 2020-9-12 -Reworded the description and added the DOI mid sentenance in the description. -I kept the name inside the parenthesis to avoid confusion, similar to https://CRAN.R-project.org/package=phyclust. -> 'reactlog' (Schloerke 2019) provides a visual insight into... - - -Thank you for the change and suggestion! +I've updated the links. Thank you! Best, Barret -#### 2019-3-18 - -> The Description field should start with a capital letter. - -Please fix and resubmit. - -Is there some reference about the method you can add in the Description -field in the form Authors (year) ? - -Best, -Uwe Ligges - - -#### 2019-3-17 - -Hello, - -Possible invalid URL: -* The README.md URL (http://www.rpackages.io/package/reactlog) is valid once reactlog is on CRAN. The webpage works, just the status is a 404. - -Single quote packages: -* Changed `Shiny` to `'shiny'` in the DESCRIPTION file. - -Omit stock license file: -* Added the License.md file to `.Rbuildignore`. - -Thank you for the changes! - -Best, -Barret +#### 2020-9-12 +Thanks, we see: - -#### 2019-3-17 - -Thanks, - +``` Found the following (possibly) invalid URLs: - URL: http://www.rpackages.io/package/reactlog + URL: https://community.rstudio.com/c/shiny (moved to +https://community.rstudio.com/c/shiny/8) From: README.md - Status: 404 - Message: Not Found - - -Please always write package names, software names and API names in -single quotes (e.g. 'Shiny') in the Title and the Description field. + Status: 200 + Message: OK + URL: +https://resources.rstudio.com/rstudio-conf-2019/reactlog-2-0-debugging-the-state-of-shiny +(moved to +https://rstudio.com/resources/rstudioconf-2019/reactlog-2-0-debugging-the-state-of-shiny/) + From: inst/doc/reactlog.html + Status: 200 + Message: OK + URL: https://yarnpkg.com/en/ (moved to https://classic.yarnpkg.com/en/) + From: README.md + Status: 200 + Message: OK + URL: https://yarnpkg.com/en/docs/install (moved to +https://classic.yarnpkg.com/en/docs/install) + From: README.md + Status: 200 + Message: OK +``` -The LICENSE file is only needed if you have additional restrictions to -the GPL-3 which you have not? In that please case omit the file. +Please change http --> https, add trailing slashes, or follow moved +content as appropriate. Please fix and resubmit. -Best, -Martina Schmirl - - -#### 2019-3-14 - -I've reduced the file size and updated the check outputs below. - -Thank you for your time! - -Best, -Barret - - -#### 2019-3-14 - -Thanks, we see: - - Size of tarball: 7138666 bytes - -Not more than 5 MB for a CRAN package, please. - Best, Uwe Ligges +#### 2019-9-11 -#### 2019-3-14 - -This is a new release. +I've added new features and bug fixes to reactlog. Please let me know if there is anything else I can provide. @@ -103,117 +57,38 @@ Barret ## R CMD check results -Overall there are no consistent notes or warnings other than the note of `reactlog` being a new submission. - -0 errors | 0 warnings | 1 note - -* NOTES: - * checking CRAN incoming feasibility ... NOTE - Maintainer: 'Barret Schloerke ' - New submission - - -False positives: -* The 404 README.md URL (http://www.rpackages.io/package/reactlog) is valid once reactlog is on cran. The webpage works, just the status is a 404. -* The WARNING for the README.md conversion on rhub is most likely due to rhub's setup. -* The NOTE for window's old release not converting Authors@R consistently. - +0 errors | 0 warnings | 0 notes ## Test environments -#### local OS X install, R 3.5.2 -* NOTES: - * checking CRAN incoming feasibility ... NOTE - Maintainer: 'Barret Schloerke ' - New submission - - Found the following (possibly) invalid URLs: - URL: http://www.rpackages.io/package/reactlog - From: README.md - Status: 404 - Message: Not Found -#### ubuntu 14.04 (on travis-ci) - -* R 3.4.4 - Status: OK - -* R 3.5.2 - Status: OK +* local macOS, R 4.0.0 +* GitHub Actions + * macOS + * oldrel, release, devel + * windows + * release + * ubuntu16 + * 3.3, 3.4, 3.5, oldrel, release, devel +0 errors ✔ | 0 warnings ✔ | 0 notes ✔ -* R Under development (unstable) (2019-03-14 r76237) - Status: OK +* devtools::check_win_devel() - -#### win-builder (devel and release) - -* R version 3.4.4 (2018-03-15) - * checking CRAN incoming feasibility ... NOTE - Maintainer: 'Barret Schloerke ' - - New submission - - Found the following (possibly) invalid URLs: - URL: http://www.rpackages.io/package/reactlog - From: README.md - Status: 404 - Message: Not Found - * checking DESCRIPTION meta-information ... NOTE - Author field differs from that derived from Authors@R - Author: 'Barret Schloerke [aut, cre] (), Joe Cheng [ctb], RStudio [cph, fnd]' - Authors@R: 'Barret Schloerke [aut, cre] (0000-0001-9986-114X), Joe Cheng [ctb], RStudio [cph, fnd]' - -* R Under development (unstable) (2019-03-12 r76226) - * checking CRAN incoming feasibility ... NOTE - Maintainer: 'Barret Schloerke ' - - New submission - - Found the following (possibly) invalid URLs: - URL: http://www.rpackages.io/package/reactlog - From: README.md - Status: 404 - Message: Not Found - -* R version 3.5.3 (2019-03-11) - * checking CRAN incoming feasibility ... NOTE - Maintainer: 'Barret Schloerke ' - - New submission - - Found the following (possibly) invalid URLs: - URL: http://www.rpackages.io/package/reactlog - From: README.md - Status: 404 - Message: Not Found -#### rhub - -* Build ID: reactlog_1.0.0.tar.gz-8f10a076c4d543ee935621494de204a2 - Platform: Windows Server 2008 R2 SP1, R-devel, 32/64 bit - R Under development (unstable) (2019-03-09 r76216) * checking CRAN incoming feasibility ... NOTE - Maintainer: 'Barret Schloerke ' + Maintainer: 'Barret Schloerke ' - New submission + Possibly mis-spelled words in DESCRIPTION: + Reactivity (2:8) + Schloerke (15:4) + reactivity (16:29) + Status: 1 NOTE -* Build ID: reactlog_1.0.0.tar.gz-61464674f5894f2aafbdeb08cde4398e - Platform: Windows Server 2008 R2 SP1, R-release, 32/64 bit - R version 3.5.3 (2019-03-11) - * checking CRAN incoming feasibility ... NOTE - Maintainer: 'Barret Schloerke ' - New submission - -* Build ID: reactlog_1.0.0.tar.gz-6f17d96a1158459d9d1a673bdf970a3d - Platform: Ubuntu Linux 16.04 LTS, R-release, GCC - R version 3.5.3 (2019-03-11) -- "Great Truth" - * checking top-level files ... WARNING - Conversion of ‘README.md’ failed: - (ConnectionFailure getProtocolByName: does not exist (no such protocol name: tcp)) - * checking CRAN incoming feasibility ... NOTE - Maintainer: ‘Barret Schloerke ’ + * I believe spellings these are false positives. + * `Schloerke` is my last name + * `reactivity` is a word we use to describe how reactive values work within 'shiny'. - New submission +## revdepcheck results -* Build ID: reactlog_1.0.0.tar.gz-ce002ac23eac49d0bf288412970c2627 - Platform: Fedora Linux, R-devel, clang, gfortran - R Under development (unstable) (2019-03-13 r76230) -- "Unsuffered Consequences" - * checking CRAN incoming feasibility ... NOTE - Maintainer: ‘Barret Schloerke ’ +We checked 1 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package. - New submission + * We saw 0 new problems + * We failed to check 0 packages diff --git a/man/reactlog_module.Rd b/man/reactlog_module.Rd index bc0e196..16dccf7 100644 --- a/man/reactlog_module.Rd +++ b/man/reactlog_module.Rd @@ -15,7 +15,7 @@ reactlog_module_server( ) } \arguments{ -\item{include_refresh}{should the ifram refresh button be included?} +\item{include_refresh}{should the iframe refresh button be included?} \item{id}{\pkg{shiny} module id to use} diff --git a/revdep/.gitignore b/revdep/.gitignore new file mode 100644 index 0000000..31f6c40 --- /dev/null +++ b/revdep/.gitignore @@ -0,0 +1,6 @@ +checks +library +checks.noindex +library.noindex +data.sqlite +*.html diff --git a/revdep/README.md b/revdep/README.md new file mode 100644 index 0000000..8f6dad9 --- /dev/null +++ b/revdep/README.md @@ -0,0 +1,28 @@ +# Platform + +|field |value | +|:--------|:----------------------------| +|version |R version 4.0.0 (2020-04-24) | +|os |macOS Catalina 10.15.6 | +|system |x86_64, darwin17.0 | +|ui |X11 | +|language |(EN) | +|collate |en_US.UTF-8 | +|ctype |en_US.UTF-8 | +|tz |America/New_York | +|date |2020-09-03 | + +# Dependencies + +|package |old |new |Δ | +|:--------|:-----|:-----|:--| +|reactlog |1.0.0 |1.1.0 |* | + +# Revdeps + +## All (1) + +|package |version |error |warning |note | +|:--------------------------|:-------|:-----|:-------|:----| +|[shiny](problems.md#shiny) |1.5.0 | | |1 | + diff --git a/revdep/failures.md b/revdep/failures.md new file mode 100644 index 0000000..9a20736 --- /dev/null +++ b/revdep/failures.md @@ -0,0 +1 @@ +*Wow, no problems at all. :)* \ No newline at end of file diff --git a/revdep/problems.md b/revdep/problems.md new file mode 100644 index 0000000..06c3a79 --- /dev/null +++ b/revdep/problems.md @@ -0,0 +1,25 @@ +# shiny + +
+ +* Version: 1.5.0 +* Source code: https://github.com/cran/shiny +* URL: http://shiny.rstudio.com +* BugReports: https://github.com/rstudio/shiny/issues +* Date/Publication: 2020-06-23 13:30:03 UTC +* Number of recursive dependencies: 97 + +Run `revdep_details(,"shiny")` for more info + +
+ +## In both + +* checking installed package size ... NOTE + ``` + installed size is 11.7Mb + sub-directories of 1Mb or more: + R 2.0Mb + www 8.5Mb + ``` + diff --git a/revdep/revdep_cran.md b/revdep/revdep_cran.md new file mode 100644 index 0000000..aef2652 --- /dev/null +++ b/revdep/revdep_cran.md @@ -0,0 +1,6 @@ +## revdepcheck results + +We checked 1 reverse dependencies, comparing R CMD check results across CRAN and dev versions of this package. + + * We saw 0 new problems + * We failed to check 0 packages diff --git a/vignettes/reactlog.Rmd b/vignettes/reactlog.Rmd index d48f89d..43b2cb6 100644 --- a/vignettes/reactlog.Rmd +++ b/vignettes/reactlog.Rmd @@ -23,7 +23,7 @@ knitr::opts_chunk$set( With v0.14.0, the **shiny** R package introduced a way to investigate the activity and logic of a **shiny** application through a visualization of it's reactive history. In version v1.3.0, **shiny** revamped this visual tool via the R package **reactlog**. The design and capabilities of this interactive visualization have vastly improved, especially for navigating large and complex reactive graphs. This vignette outlines the new design and helps explain how to navigate the new interface. -To understand **reactlog**, it helps to have a basic understanding of **shiny**'s reactive programming model. If you're fairly new to **shiny** and reactive programming, the next section, which has been modified from the [_Mastering Shiny_ book by Joe Cheng](https://github.com/jcheng5/shiny-book), provides an overview of **shiny**'s reactivity model and is designed specifically for understanding **reactlog**. You'll notice the terminology, concepts, and graphics are consistent with **reactlog**, which is introduced in the [Hello Reactlog](#reactlog) section through code and video demonstrations. Heavy users of **reactlog** may find the [Reactlog in detail](#reactlog-in-detail) section helpful to detailing all the individual components of the **reactlog** interface. Finally, the [Learn more](#learn-more) section has links to more resources for learning even more about reactivity in **shiny**. +To understand **reactlog**, it helps to have a basic understanding of **shiny**'s reactive programming model. If you're fairly new to **shiny** and reactive programming, the next section, which has been modified from the [_Mastering Shiny_ book by Hadley Wickham](https://mastering-shiny.org/), provides an overview of **shiny**'s reactivity model and is designed specifically for understanding **reactlog**. You'll notice the terminology, concepts, and graphics are consistent with **reactlog**, which is introduced in the [Hello Reactlog](#reactlog) section through code and video demonstrations. Heavy users of **reactlog** may find the [Reactlog in detail](#reactlog-in-detail) section helpful to detailing all the individual components of the **reactlog** interface. Finally, the [Learn more](#learn-more) section has links to more resources for learning even more about reactivity in **shiny**. ## The reactive life cycle {#reactivity} @@ -357,7 +357,7 @@ This vignette explains the **reactlog** interface, which requires a basic unders * Why a `clientData` is randomly appearing in the reactive graph * How to prevent reactivity from executing using `isolate()` * The **shiny** [tutorials](https://shiny.rstudio.com/tutorial/), which provides many great instructional videos and various learning resources. -* The `rstudio::conf2019` talk by Barret Schloerke: _Reactlog 2.0: Debugging the State of Shiny_ ([Video](https://resources.rstudio.com/rstudio-conf-2019/reactlog-2-0-debugging-the-state-of-shiny) / [Slides](https://github.com/schloerke/presentation-2019-01-18-reactlog/blob/master/rstudio-conf-2019-reactlog.pdf)). -* [Effective Reactive Programming](https://www.rstudio.com/resources/videos/effective-reactive-programming/): +* The `rstudio::conf2019` talk by Barret Schloerke: _Reactlog 2.0: Debugging the State of Shiny_ ([Video](https://rstudio.com/resources/rstudioconf-2019/reactlog-2-0-debugging-the-state-of-shiny/) / [Slides](https://github.com/schloerke/presentation-2019-01-18-reactlog/blob/master/rstudio-conf-2019-reactlog.pdf)). +* Effective Reactive Programming [Part 1](https://rstudio.com/resources/shiny-dev-con/reactivity-pt-1-joe-cheng/) [Part 2](https://rstudio.com/resources/shiny-dev-con/reactivity-pt-2/): * "This tutorial will go beyond the basics, explaining the philosophy behind Shiny’s reactive programming framework and exploring patterns and techniques for using it well." -* [Mastering Shiny](https://github.com/jcheng5/shiny-book) by Joe Cheng +* [Mastering Shiny](https://mastering-shiny.org) by Hadley Wickham