Rename teal_data_module.R functions

R/dummy_functions.R

@@ -62,7 +62,7 @@ example_module <- function(label = "example teal module",
 
         table_data_decorated_no_print <- srv_transform_teal_data(
           "decorate",
-          data = table_data,
+          teal_data_r = table_data,
           transformators = decorators
         )
         table_data_decorated <- reactive(within(req(table_data_decorated_no_print()), expr = object))

R/module_nested_tabs.R

@@ -263,7 +263,7 @@ srv_teal_module.teal_module <- function(id,
       is_transform_failed <- reactiveValues()
       transformed_teal_data <- srv_transform_teal_data(
         "data_transform",
-        data = filtered_teal_data,
+        teal_data_r = filtered_teal_data,
         transformators = modules$transformators,
         modules = modules,
         is_transform_failed = is_transform_failed

R/module_teal_data.R

@@ -21,7 +21,7 @@
 #' (except error 1).
 #'
 #' @param id (`character(1)`) Module id
-#' @param data (`reactive teal_data`)
+#' @param teal_data_r (`reactive teal_data`)
 #' @param data_module (`teal_data_module`)
 #' @param modules (`teal_modules` or `teal_module`) For `datanames` validation purpose
 #' @param validate_shiny_silent_error (`logical`) If `TRUE`, then `shiny.silent.error` is validated and
@@ -37,7 +37,10 @@
 NULL
 
 #' @rdname module_teal_data
-ui_teal_data <- function(id, data_module = function(id) NULL) {
+#' @aliases ui_teal_data
+#' @note
+#' `ui_teal_data_module` was renamed from `ui_teal_data`.
+ui_teal_data_module <- function(id, data_module = function(id) NULL) {
   checkmate::assert_string(id)
   checkmate::assert_function(data_module, args = "id")
   ns <- NS(id)
@@ -49,23 +52,26 @@ ui_teal_data <- function(id, data_module = function(id) NULL) {
 }
 
 #' @rdname module_teal_data
-srv_teal_data <- function(id,
-                          data_module = function(id) NULL,
-                          modules = NULL,
-                          validate_shiny_silent_error = TRUE,
-                          is_transform_failed = reactiveValues()) {
+#' @aliases srv_teal_data
+#' @note
+#' `srv_teal_data_module` was renamed from `srv_teal_data`.
+srv_teal_data_module <- function(id,
+                                 data_module = function(id) NULL,
+                                 modules = NULL,
+                                 validate_shiny_silent_error = TRUE,
+                                 is_transform_failed = reactiveValues()) {
   checkmate::assert_string(id)
   checkmate::assert_function(data_module, args = "id")
   checkmate::assert_multi_class(modules, c("teal_modules", "teal_module"), null.ok = TRUE)
   checkmate::assert_class(is_transform_failed, "reactivevalues")
 
   moduleServer(id, function(input, output, session) {
-    logger::log_debug("srv_teal_data initializing.")
+    logger::log_debug("srv_teal_data_module initializing.")
     is_transform_failed[[id]] <- FALSE
-    data_out <- data_module(id = "data")
-    data_handled <- reactive(tryCatch(data_out(), error = function(e) e))
-    observeEvent(data_handled(), {
-      if (!inherits(data_handled(), "teal_data")) {
+    module_out <- data_module(id = "data")
+    try_module_out <- reactive(tryCatch(module_out(), error = function(e) e))
+    observeEvent(try_module_out(), {
+      if (!inherits(try_module_out(), "teal_data")) {
         is_transform_failed[[id]] <- TRUE
       } else {
         is_transform_failed[[id]] <- FALSE
@@ -89,7 +95,7 @@ srv_teal_data <- function(id,
 
     srv_validate_reactive_teal_data(
       "validate",
-      data = data_handled,
+      teal_data_r = try_module_out,
       modules = modules,
       validate_shiny_silent_error = validate_shiny_silent_error,
       hide_validation_error = is_previous_failed
@@ -117,7 +123,7 @@ ui_validate_reactive_teal_data <- function(id) {
 
 #' @rdname module_teal_data
 srv_validate_reactive_teal_data <- function(id, # nolint: object_length
-                                            data,
+                                            teal_data_r,
                                             modules = NULL,
                                             validate_shiny_silent_error = FALSE,
                                             hide_validation_error = reactive(FALSE)) {
@@ -127,9 +133,9 @@ srv_validate_reactive_teal_data <- function(id, # nolint: object_length
 
   moduleServer(id, function(input, output, session) {
     # there is an empty reactive cycle on `init` and `data_rv` has `shiny.silent.error` class
-    srv_validate_error("silent_error", data, validate_shiny_silent_error)
-    srv_check_class_teal_data("class_teal_data", data)
-    srv_check_module_datanames("shiny_warnings", data, modules)
+    srv_validate_error("silent_error", teal_data_r, validate_shiny_silent_error)
+    srv_check_class_teal_data("class_teal_data", teal_data_r)
+    srv_check_module_datanames("shiny_warnings", teal_data_r, modules)
     output$previous_failed <- renderUI({
       if (hide_validation_error()) {
         shinyjs::hide("validate_messages")
@@ -140,7 +146,7 @@ srv_validate_reactive_teal_data <- function(id, # nolint: object_length
       }
     })
 
-    .trigger_on_success(data)
+    .trigger_on_success(teal_data_r)
   })
 }
 

R/module_transform_data.R

@@ -74,12 +74,16 @@ ui_transform_teal_data <- function(id, transformators, class = "well") {
 
 #' @export
 #' @rdname module_transform_data
-srv_transform_teal_data <- function(id, data, transformators, modules = NULL, is_transform_failed = reactiveValues()) {
+srv_transform_teal_data <- function(id,
+                                    teal_data_r,
+                                    transformators,
+                                    modules = NULL,
+                                    is_transform_failed = reactiveValues()) {
   checkmate::assert_string(id)
-  assert_reactive(data)
+  assert_reactive(teal_data_r)
   checkmate::assert_class(modules, "teal_module", null.ok = TRUE)
   if (length(transformators) == 0L) {
-    return(data)
+    return(teal_data_r)
   }
   if (inherits(transformators, "teal_transform_module")) {
     transformators <- list(transformators)
@@ -142,7 +146,7 @@ srv_transform_teal_data <- function(id, data, transformators, modules = NULL, is
         })
       },
       x = names(transformators),
-      init = data
+      init = teal_data_r
     )
     module_output
   })

tests/testthat/test-teal_transform_module.R

@@ -12,7 +12,7 @@ testthat::describe("make_teal_transform_server produces a valid teal_transform_m
       app = srv_transform_teal_data,
       args = list(
         id = "test",
-        data = reactive(teal.data::teal_data(data1 = iris, data2 = mtcars)),
+        teal_data_r = reactive(teal.data::teal_data(data1 = iris, data2 = mtcars)),
         transformators = output_decorator
       ),
       expr = {
@@ -35,7 +35,7 @@ testthat::describe("make_teal_transform_server produces a valid teal_transform_m
       app = srv_transform_teal_data,
       args = list(
         id = "test",
-        data = reactive(teal.data::teal_data(data1 = iris, data2 = mtcars)),
+        teal_data_r = reactive(teal.data::teal_data(data1 = iris, data2 = mtcars)),
         transformators = output_decorator
       ),
       expr = {
@@ -68,7 +68,7 @@ testthat::test_that(
       app = srv_transform_teal_data,
       args = list(
         id = initial_id,
-        data = reactive(within(teal_data(), iris <- iris)),
+        teal_data_r = reactive(within(teal_data(), iris <- iris)),
         transformators = ttm
       ),
       expr = {