rename qenv

DESCRIPTION

@@ -91,6 +91,7 @@ Collate:
     'modules_debugging.R'
     'reporter_previewer_module.R'
     'show_rcode_modal.R'
+    'tdata.R'
     'teal.R'
     'utils.R'
     'validations.R'

NAMESPACE

@@ -1,5 +1,9 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method(get_code,default)
+S3method(get_code,tdata)
+S3method(get_join_keys,default)
+S3method(get_join_keys,tdata)
 S3method(is_arg_used,"function")
 S3method(is_arg_used,default)
 S3method(is_arg_used,teal_module)
@@ -20,17 +24,21 @@ export(.log)
 export(bookmarkableShinyApp)
 export(default_filter)
 export(example_module)
+export(get_code)
+export(get_join_keys)
 export(get_rcode)
 export(get_rcode_srv)
 export(get_rcode_ui)
 export(init)
 export(log_app_usage)
 export(module)
 export(modules)
+export(new_tdata)
 export(reporter_previewer_module)
 export(root_modules)
 export(show_rcode_modal)
 export(srv_teal_with_splash)
+export(tdata2env)
 export(ui_teal_with_splash)
 export(validate_has_data)
 export(validate_has_elements)

NEWS.md

@@ -3,7 +3,7 @@
 ### Enhancements
 
 * Added option to choose which variables can be filtered in the filter panel by using the `filterable` attributes for the per-dataset lists in the `filter` argument of `init`. 
-* `teal_module` having `data` argument in its arguments will receive a list of reactive filter data with `"code"` and `"join_keys"` attributes.
+* `teal_module` having `data` argument in its arguments of type `tdata`. Modules receive this object (a list of reactive filter data with `"code"` and `"join_keys"` attributes).
 * Updated the internals of `module_teal` to reflect changes in `teal.slice`.
 * `teal_module` having `filter_panel_api` argument in its arguments will receive a `FilterPanelAPI` object.
 

R/example_module.R

@@ -20,6 +20,7 @@ example_module <- function(label = "example teal module") {
   module(
     label,
     server = function(id, data) {
+      checkmate::assert_class(data, "tdata")
       moduleServer(id, function(input, output, session) {
         output$text <- renderPrint(data[[input$dataname]]())
       })

R/module_nested_tabs.R

@@ -228,9 +228,9 @@ srv_nested_tabs.teal_module <- function(id, datasets, modules, reporter) {
   reactive(modules)
 }
 
-#' Convert `FilteredData` to reactive list of data
+#' Convert `FilteredData` to reactive list of data of type `tdata`.
 #'
-#' Converts `FilteredData` object to list of data containing datasets needed for specific module.
+#' Converts `FilteredData` object to `tdata` object containing datasets needed for specific module.
 #' Please note that if module needs dataset which has a parent, then parent will be also returned.
 #'
 #' @param module (`teal_module`) module where needed filters are taken from
@@ -255,10 +255,5 @@ srv_nested_tabs.teal_module <- function(id, datasets, modules, reporter) {
     }
   )
 
-  # code from previous stages
-  attr(data, "code") <- get_datasets_code(datanames, datasets)
-
-  # join_keys
-  attr(data, "join_keys") <- datasets$get_join_keys()
-  data
+  new_tdata(data, reactive(get_datasets_code(datanames, datasets)), datasets$get_join_keys())
 }

R/modules_debugging.R

@@ -10,8 +10,6 @@
 #' and avoids session restarts!
 #'
 #' @param label `character` label of module
-#' @param active_datanames `character vector` datanames shown in filter panel;
-#'   can be `"all"` to mean all available datasets
 #' @keywords internal
 #'
 #' @examples
@@ -34,19 +32,19 @@
 #'   ),
 #'   header = "Simple teal app"
 #' )
-#' \dontrun{
-#' shinyApp(app$ui, app$server)
+#' if (interactive()) {
+#'   shinyApp(app$ui, app$server)
 #' }
-filter_calls_module <- function(label = "Filter Calls Module", active_datanames = "all") { # nolint
+filter_calls_module <- function(label = "Filter Calls Module") { # nolint
   checkmate::assert_string(label)
-  checkmate::check_character(active_datanames, min.len = 1, any.missing = FALSE)
 
   module(
     label = label,
-    server = function(input, output, session, datasets) {
+    server = function(input, output, session, data) {
+      checkmate::assert_class(data, "tdata")
+
       output$filter_calls <- renderText({
-        active_datanames <- datasets$handle_active_datanames(active_datanames)
-        teal.slice::get_filter_expr(datasets, datanames = active_datanames)
+        get_code(data)
       })
     },
     ui = function(id, ...) {
@@ -56,6 +54,6 @@ filter_calls_module <- function(label = "Filter Calls Module", active_datanames
         verbatimTextOutput(ns("filter_calls"))
       )
     },
-    filters = active_datanames
+    filters = "all"
   )
 }

R/tdata.R

@@ -0,0 +1,52 @@
+#' @export
+new_tdata <- function(data, code, join_keys) {
+
+  #validation here
+
+  # code from previous stages
+  attr(data, "code") <- code
+
+  # join_keys
+  attr(data, "join_keys") <- join_keys
+
+  # set class
+  class(data) <- c("tdata", class(data))
+  data
+}
+
+#' @export
+tdata2env <- function(data) { # nolint
+  #validation
+
+  list2env(lapply(data, function(x) if (is.reactive(x)) x() else x))
+}
+
+#' @export
+get_code <- function(data) {
+  UseMethod("get_code", data)
+}
+
+#' @export
+get_join_keys <- function(data) {
+  UseMethod("get_join_keys", data)
+}
+
+#' @export
+get_code.tdata <- function(data) {
+  attr(data, "code")()
+}
+
+#' @export
+get_join_keys.tdata <- function(data) {
+  attr(data, "join_keys")
+}
+
+#' @export
+get_join_keys.default <- function(data) {
+  stop("get_join_keys function not implemented for this object")
+}
+
+#' @export
+get_code.default <- function(data) {
+  stop("get_code function not implemented for this object")
+}

vignettes/adding-support-for-reporting.Rmd

@@ -34,6 +34,7 @@ teal_example_module <- function(label = "example teal module") {
   module(
     label,
     server = function(id, data) {
+      checkmate::assert_class(data, "tdata")
       moduleServer(id, function(input, output, session) {
         output$text <- renderPrint(data[[input$dataname]]())
       })
@@ -65,14 +66,14 @@ if (interactive()) shinyApp(app$ui, app$server)
 
 ## Add support for Reporting
 ### Change the declaration of the server function
-The first step is to add another argument to the server function declaration - `reporter`. This needs to be the third
-argument to the server function inside the `teal.module` call. See below:
+The first step is to add another argument to the server function declaration - `reporter`. See below:
 ```{r}
 example_module_with_reporting <- function(label = "example teal module") {
   checkmate::assert_string(label)
   module(
     label,
     server = function(id, data, reporter) {
+      checkmate::assert_class(data, "tdata")
       moduleServer(id, function(input, output, session) {
         output$text <- renderPrint(data[[input$dataname]]())
       })
@@ -115,6 +116,7 @@ example_module_with_reporting <- function(label = "example teal module") {
   module(
     label,
     server = function(id, data, reporter) {
+      checkmate::assert_class(data, "tdata")
       moduleServer(id, function(input, output, session) {
         teal.reporter::simple_reporter_srv(
           id = "reporter",
@@ -177,6 +179,7 @@ example_module_with_reporting <- function(label = "example teal module") {
   module(
     label,
     server = function(id, data, reporter) {
+      checkmate::assert_class(data, "tdata")
       moduleServer(id, function(input, output, session) {
         teal.reporter::simple_reporter_srv(id = "simpleReporter", reporter = reporter, card_fun = custom_function)
         output$text <- renderPrint(data[[input$dataname]]())
@@ -244,6 +247,7 @@ example_reporter_module <- function(label = "Example") {
     label,
     server = function(id, data, reporter, filter_panel_api) {
       with_filter <- !missing(filter_panel_api) && inherits(filter_panel_api, "FilterPanelApi")
+      checkmate::assert_class(data, "tdata")
       moduleServer(id, function(input, output, session) {
         dat <- reactive(data[[input$dataname]]())
         output$nrow_ui <- renderUI({
@@ -253,7 +257,7 @@ example_reporter_module <- function(label = "Example") {
         table_q <- reactive({
           req(input$nrow)
 
-          teal.code::new_quosure(env = data) %>%
+          teal.code::new_qenv(tdata2env(data), code = get_code(data)) %>%
             teal.code::eval_code(
               substitute(
                 result <- head(data, nrows),

vignettes/creating-custom-modules.Rmd

@@ -23,6 +23,7 @@ example_module <- function(label = "example teal module") {
   module(
     label,
     server = function(id, data) {
+      checkmate::assert_class(data, "tdata")
       moduleServer(id, function(input, output, session) {
         output$text <- renderPrint(data[[input$dataname]]())
       })
@@ -70,7 +71,8 @@ function(id,
 ```
 
 When used inside a teal application called with `teal::init` the `data` argument is a named list of reactive data.frames
-containing the data after having been filtered through the filter panel.
+containing the data after having been filtered through the filter panel. It is of type `tdata` and can be created using
+the `new_tdata` function.
 
 ## A More Complicated Example
 
@@ -114,25 +116,26 @@ ui_histogram_example <- function(id, histogram_var) {
 # histogram_var is a teal.transform::data_extract_spec object
 # specifying which columns of which datasets users can choose
 srv_histogram_example <- function(id, data, histogram_var) {
+  checkmate::assert_class(data, "tdata")
   moduleServer(id, function(input, output, session) {
 
     # get the selected dataset and column from the UI
     extracted <- teal.transform::data_extract_srv(
       id = "histogram_var",
       datasets = data,
       data_extract_spec = histogram_var,
-      join_keys = attr(data, "join_keys")
+      join_keys = get_join_keys(data)
     )
 
     dataname <- reactive(extracted()$dataname)
     selected <- reactive(extracted()$select)
 
-    # the reactive which adds the code to plot the histogram into the quosure
+    # the reactive which adds the code to plot the histogram into the qenv
     plot_code_q <- reactive({
       validate(need(length(selected) == 1, "Please select a variable"))
 
-      # take the filtered data from the data object and add it into the quosure environment
-      teal.code::new_quosure(env = data) %>%
+      # take the filtered data from the data object and add it into the qenv environment
+      teal.code::new_qenv(tdata2env(data), code = get_code(data)) %>%
         teal.code::eval_code(
           substitute(
             expr = p <- hist(dataname[, selected]),