CRANspection

Author: romainfrancois

DESCRIPTION

@@ -1,10 +1,9 @@
 Package: react
 Title: Reactivity Helper for 'shiny'
-Version: 2024.1.1
+Version: 2024.1.0
 Authors@R: 
-    person("Romain", "François", email = "[email protected]", role = c("aut", "cre"),
-           comment = c(ORCID = "0000-0002-2444-4226"))
-Description: Tools to help with shiny reactivity. The 'react' object offers
+    person("Romain", "François", email = "[email protected]", role = c("aut", "cre"))
+Description: Tools to help with 'shiny' reactivity. The 'react' object offers
     an alternative way to call reactive expressions to better identify them
     in the server code. 
 License: MIT + file LICENSE

R/react.R

@@ -6,17 +6,33 @@
 #' The benefit is that it makes them easier to spot in your code.
 #'
 #' @examples
+#' # This works by invoking the function from the parent environment
+#' # with no arguments ...
+#' foo <- function() {
+#'   42
+#' }
+#' react$foo
+#' react[foo]
+#' react[foo()]
+#'
 #' \dontrun{
-#'   # imagine you have some shiny reactive
-#'   foo <- reactive({
-#'     whatever() + something()
-#'   })
+#'   # ... but it only becomes relevant when used in shiny
+#'   # server code, e.g. this app from the shiny page
+#'   # with react$dataInput instead of dataInput()
+#'   server <- function(input, output) {
+#'
+#'     dataInput <- reactive({
+#'       getSymbols(input$symb, src = "yahoo",
+#'           from = input$dates[1],
+#'             to = input$dates[2],
+#'             auto.assign = FALSE)
+#'     })
 #'
-#'   # react allows you to call it in 3 different ways
-#'   # instead of the usual foo() form
-#'   react$foo
-#'   react[foo]
-#'   react[foo()]
+#'     output$plot <- renderPlot({
+#'        chartSeries(react$dataInput, theme = chartTheme("white"),
+#'               type = "line", log.scale = input$log, TA = NULL)
+#'     })
+#'   }
 #' }
 #' @export
 react <- structure(list(), class = "react")