diff --git a/.github/workflows/R-CMD-check.yaml b/.github/workflows/R-CMD-check.yaml index 43e9415..58f17cc 100644 --- a/.github/workflows/R-CMD-check.yaml +++ b/.github/workflows/R-CMD-check.yaml @@ -17,5 +17,9 @@ jobs: uses: rstudio/shiny-workflows/.github/workflows/website.yaml@v1 routine: uses: rstudio/shiny-workflows/.github/workflows/routine.yaml@v1 + with: + node-version: "16" R-CMD-check: uses: rstudio/shiny-workflows/.github/workflows/R-CMD-check.yaml@v1 + with: + check-depends-only: false diff --git a/DESCRIPTION b/DESCRIPTION index 1a4dcc2..00a1043 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -2,36 +2,37 @@ Package: reactlog Title: Reactivity Visualizer for 'shiny' Version: 1.1.1 Authors@R: c( - person( - "Barret", "Schloerke", email = "barret@rstudio.com", role = c("aut", "cre"), - comment = c(ORCID = "0000-0001-9986-114X") - ), - person("Joe", "Cheng", email = "joe@rstudio.com", role = c("ctb")), - person("RStudio", role = c("cph", "fnd")) - ) -Description: Building interactive web applications with R is incredibly easy - with 'shiny'. Behind the scenes, 'shiny' builds a reactive graph that can - quickly become intertwined and difficult to debug. 'reactlog' - (Schloerke 2019) provides a visual insight into - that black box of 'shiny' reactivity by constructing a directed dependency - graph of the application's reactive state at any time point in a reactive - recording. + person("Barret", "Schloerke", , "barret@rstudio.com", role = c("aut", "cre"), + comment = c(ORCID = "0000-0001-9986-114X")), + person("Joe", "Cheng", , "joe@rstudio.com", role = "ctb"), + person("RStudio", role = c("cph", "fnd")) + ) +Description: Building interactive web applications with R is incredibly + easy with 'shiny'. Behind the scenes, 'shiny' builds a reactive graph + that can quickly become intertwined and difficult to debug. 'reactlog' + (Schloerke 2019) provides a visual + insight into that black box of 'shiny' reactivity by constructing a + directed dependency graph of the application's reactive state at any + time point in a reactive recording. +License: GPL-3 | file LICENSE +URL: https://rstudio.github.io/reactlog/, + https://github.com/rstudio/reactlog, + https://community.rstudio.com/tag/reactlog +BugReports: https://github.com/rstudio/reactlog/issues Depends: - R (>= 3.0.2) + R (>= 3.0.2) Imports: - jsonlite (>= 0.9.16), + jsonlite (>= 0.9.16) Suggests: - shiny (>= 1.5.0), fontawesome (>= 0.3.0), + htmltools, knitr, rmarkdown, - htmltools, + shiny (>= 1.5.0), testthat -License: GPL-3 | file LICENSE +VignetteBuilder: + knitr Encoding: UTF-8 -RoxygenNote: 7.2.1 -URL: https://rstudio.github.io/reactlog/, https://github.com/rstudio/reactlog, https://community.rstudio.com/tag/reactlog -BugReports: https://github.com/rstudio/reactlog/issues -VignetteBuilder: knitr Language: en-US Roxygen: list(markdown = TRUE) +Config/roxygen2/version: 8.0.0 diff --git a/R/shinyModule.R b/R/shinyModule.R index 830dd1f..bb17f21 100644 --- a/R/shinyModule.R +++ b/R/shinyModule.R @@ -16,11 +16,7 @@ #' @rdname reactlog_module #' @export #' @examples -#' if (!require("shiny")) { -#' message("`shiny` required to run example") -#' return() -#' } -#' +#' \dontrun{ #' library(shiny) #' # Enable reactlog #' reactlog_enable() @@ -55,6 +51,7 @@ #' if (interactive()) { #' shinyApp(ui = ui, server = server) #' } +#' } reactlog_module_ui <- function(include_refresh = TRUE, id = "reactlog_module") { ns <- shiny::NS(id) shiny::tagList( @@ -135,7 +132,7 @@ shiny_version_required <- function() { test_shiny_version <- function() { tryCatch({ utils::packageVersion("shiny") >= shiny_version_required() - }, error = function() { + }, error = function(e) { # package not found FALSE }) diff --git a/bin/postinstall.sh b/bin/postinstall.sh index 6c14877..128a804 100755 --- a/bin/postinstall.sh +++ b/bin/postinstall.sh @@ -1,7 +1,3 @@ #!/bin/bash -e -# do not create stubs from missing libraries -# ignore dev dependencies -yarn flow-typed install --skip true --ignoreDeps dev - yarn build-only diff --git a/man/reactlog_module.Rd b/man/reactlog_module.Rd index 16dccf7..5d4d20e 100644 --- a/man/reactlog_module.Rd +++ b/man/reactlog_module.Rd @@ -32,11 +32,7 @@ To open the reactlog at a particular step, be sure to mark your time points with \code{Cmd+Shift+F3} (Windows: \code{Ctrl+Shift+F3}) } \examples{ -if (!require("shiny")) { - message("`shiny` required to run example") - return() -} - +\dontrun{ library(shiny) # Enable reactlog reactlog_enable() @@ -72,6 +68,7 @@ if (interactive()) { shinyApp(ui = ui, server = server) } } +} \seealso{ \code{\link[shiny:moduleServer]{shiny::moduleServer()}} } diff --git a/man/reactlog_show.Rd b/man/reactlog_show.Rd index b4adce6..bcd31c0 100644 --- a/man/reactlog_show.Rd +++ b/man/reactlog_show.Rd @@ -43,11 +43,11 @@ in the process, not just for a particular application or session. As an alternative to pressing \preformatted{Ctrl/Cmd+F3}--for example, if you are using reactives outside of the context of a Shiny -application--you can run the \code{\link[shiny:reactlog]{shiny::reactlogShow()}} function, which will +application--you can run the \code{\link[shiny:reactlogShow]{shiny::reactlogShow()}} function, which will generate the reactive log visualization as a static HTML file and launch it in your default browser. In this case, refreshing your browser will not load new activity into the report; you will need to -call \code{\link[shiny:reactlog]{shiny::reactlogShow()}} explicitly. +call \code{\link[shiny:reactlogShow]{shiny::reactlogShow()}} explicitly. For security and performance reasons, do not enable the reactlog in production environments. When the option is @@ -72,6 +72,6 @@ shiny::reactlogShow() } } \seealso{ -\code{\link[shiny:reactlog]{shiny::reactlogShow()}} and +\code{\link[shiny:reactlogShow]{shiny::reactlogShow()}} and \code{\link[=reactlog_enable]{reactlog_enable()}} }