unify decorators and transformators default values

insightsengineering · Jan 17, 2025 · 7e89058 · 7e89058
1 parent a00f139
commit 7e89058
Show file tree

Hide file tree

Showing 28 changed files with 109 additions and 115 deletions.
diff --git a/R/tm_a_pca.R b/R/tm_a_pca.R
@@ -134,7 +134,7 @@ tm_a_pca <- function(label = "Principal Component Analysis",
                      pre_output = NULL,
                      post_output = NULL,
                      transformators = list(),
-                     decorators = NULL) {
+                     decorators = list()) {
   message("Initializing tm_a_pca")
 
   # Normalize the parameters

diff --git a/R/tm_a_regression.R b/R/tm_a_regression.R
@@ -158,7 +158,7 @@ tm_a_regression <- function(label = "Regression Analysis",
                             default_outlier_label = "USUBJID",
                             label_segment_threshold = c(0.5, 0, 10),
                             transformators = list(),
-                            decorators = NULL) {
+                            decorators = list()) {
   message("Initializing tm_a_regression")
 
   # Normalize the parameters

diff --git a/R/tm_g_association.R b/R/tm_g_association.R
@@ -139,7 +139,7 @@ tm_g_association <- function(label = "Association",
                              post_output = NULL,
                              ggplot2_args = teal.widgets::ggplot2_args(),
                              transformators = list(),
-                             decorators = NULL) {
+                             decorators = list()) {
   message("Initializing tm_g_association")
 
   # Normalize the parameters

diff --git a/R/tm_g_bivariate.R b/R/tm_g_bivariate.R
@@ -196,7 +196,7 @@ tm_g_bivariate <- function(label = "Bivariate Plots",
                            pre_output = NULL,
                            post_output = NULL,
                            transformators = list(),
-                           decorators = NULL) {
+                           decorators = list()) {
   message("Initializing tm_g_bivariate")
 
   # Normalize the parameters

diff --git a/R/tm_g_distribution.R b/R/tm_g_distribution.R
@@ -151,7 +151,7 @@ tm_g_distribution <- function(label = "Distribution Module",
                               pre_output = NULL,
                               post_output = NULL,
                               transformators = list(),
-                              decorators = NULL) {
+                              decorators = list()) {
   message("Initializing tm_g_distribution")
 
   # Normalize the parameters

diff --git a/R/tm_g_response.R b/R/tm_g_response.R
@@ -157,7 +157,7 @@ tm_g_response <- function(label = "Response Plot",
                           pre_output = NULL,
                           post_output = NULL,
                           transformators = list(),
-                          decorators = NULL) {
+                          decorators = list()) {
   message("Initializing tm_g_response")
 
   # Normalize the parameters

diff --git a/R/tm_g_scatterplot.R b/R/tm_g_scatterplot.R
@@ -240,7 +240,7 @@ tm_g_scatterplot <- function(label = "Scatterplot",
                              table_dec = 4,
                              ggplot2_args = teal.widgets::ggplot2_args(),
                              transformators = list(),
-                             decorators = NULL) {
+                             decorators = list()) {
   message("Initializing tm_g_scatterplot")
 
   # Normalize the parameters

diff --git a/R/tm_g_scatterplotmatrix.R b/R/tm_g_scatterplotmatrix.R
@@ -178,7 +178,7 @@ tm_g_scatterplotmatrix <- function(label = "Scatterplot Matrix",
                                    pre_output = NULL,
                                    post_output = NULL,
                                    transformators = list(),
-                                   decorators = NULL) {
+                                   decorators = list()) {
   message("Initializing tm_g_scatterplotmatrix")
 
   # Normalize the parameters

diff --git a/R/tm_missing_data.R b/R/tm_missing_data.R
@@ -118,7 +118,7 @@ tm_missing_data <- function(label = "Missing data",
                             pre_output = NULL,
                             post_output = NULL,
                             transformators = list(),
-                            decorators = NULL) {
+                            decorators = list()) {
   message("Initializing tm_missing_data")
 
   # Normalize the parameters

diff --git a/R/tm_outliers.R b/R/tm_outliers.R
@@ -158,7 +158,7 @@ tm_outliers <- function(label = "Outliers Module",
                         pre_output = NULL,
                         post_output = NULL,
                         transformators = list(),
-                        decorators = NULL) {
+                        decorators = list()) {
   message("Initializing tm_outliers")
 
   # Normalize the parameters

diff --git a/R/tm_t_crosstable.R b/R/tm_t_crosstable.R
@@ -144,7 +144,7 @@ tm_t_crosstable <- function(label = "Cross Table",
                             post_output = NULL,
                             basic_table_args = teal.widgets::basic_table_args(),
                             transformators = list(),
-                            decorators = NULL) {
+                            decorators = list()) {
   message("Initializing tm_t_crosstable")
 
   # Normalize the parameters

diff --git a/R/utils.R b/R/utils.R
@@ -34,8 +34,8 @@
 #' - When the length of `size` is three: the plot points size are dynamically adjusted based on
 #' vector of `value`, `min`, and `max`.
 #' @param decorators `r lifecycle::badge("experimental")`
-#' (`list` of `teal_transform_module`, named `list` of `teal_transform_module` or `NULL`) optional,
-#' if not `NULL`, decorator for tables or plots included in the module.
+#' (`list` of `teal_transform_module`, named `list` of `teal_transform_module`) optional,
+#' decorator for tables or plots included in the module.
 #' When a named list of `teal_transform_module`, the decorators are applied to the respective output objects.
 #'
 #' Otherwise, the decorators are applied to all objects, which is equivalent as using the name `default`.
@@ -342,14 +342,9 @@ ui_decorate_teal_data <- function(id, decorators, ...) {
 
 #' Internal function to check if decorators is a valid object
 #' @noRd
-check_decorators <- function(x, names = NULL, null.ok = FALSE) { # nolint: object_name.
-  checkmate::qassert(null.ok, "B1")
+check_decorators <- function(x, names = NULL) { # nolint: object_name.
 
-  check_message <- checkmate::check_list(
-    x,
-    null.ok = null.ok,
-    names = "named"
-  )
+  check_message <- checkmate::check_list(x, names = "named" )
 
   if (!is.null(names)) {
     check_message <- if (isTRUE(check_message)) {
@@ -373,7 +368,6 @@ check_decorators <- function(x, names = NULL, null.ok = FALSE) { # nolint: objec
     x,
     checkmate::test_list,
     types = "teal_transform_module",
-    null.ok = TRUE,
     FUN.VALUE = logical(1L)
   )
 
@@ -411,7 +405,7 @@ select_decorators <- function(decorators, scope) {
 #' @return A named list of lists with `teal_transform_module` objects.
 #' @keywords internal
 normalize_decorators <- function(decorators) {
-  if (checkmate::test_list(decorators, "teal_transform_module", null.ok = TRUE)) {
+  if (checkmate::test_list(decorators, "teal_transform_module")) {
     if (checkmate::test_names(names(decorators))) {
       lapply(decorators, list)
     } else {

diff --git a/man/shared_params.Rd b/man/shared_params.Rd
diff --git a/man/tm_a_pca.Rd b/man/tm_a_pca.Rd