Merge branch 'main' into 786_attached_packages@main

Author: m7pr

DESCRIPTION

@@ -1,8 +1,8 @@
 Type: Package
 Package: teal.modules.general
 Title: General Modules for 'teal' Applications
-Version: 0.3.0.9081
-Date: 2025-02-13
+Version: 0.3.0.9082
+Date: 2025-02-18
 Authors@R: c(
     person("Dawid", "Kaledkowski", , "[email protected]", role = c("aut", "cre")),
     person("Pawel", "Rucki", , "[email protected]", role = "aut"),

NEWS.md

@@ -1,4 +1,4 @@
-# teal.modules.general 0.3.0.9081
+# teal.modules.general 0.3.0.9082
 
 * Removed `Show Warnings` modals from modules.
 * Soft deprecated `datasets_selected` argument of modules in favor of `datanames`.

R/tm_a_pca.R

@@ -25,20 +25,18 @@
 #' - `biplot` (`ggplot2`)
 #' - `eigenvector_plot` (`ggplot2`)
 #'
-#' Decorators can be applied to all outputs or only to specific objects using a
-#' named list of `teal_transform_module` objects.
-#' The `"default"` name is reserved for decorators that are applied to all outputs.
+#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
+#' The name of this list corresponds to the name of the output to which the decorator is applied.
 #' See code snippet below:
 #'
 #' ```
 #' tm_a_pca(
 #'    ..., # arguments for module
 #'    decorators = list(
-#'      default = list(teal_transform_module(...)), # applied to all outputs
-#'      elbow_plot = list(teal_transform_module(...)), # applied only to `elbow_plot` output
-#'      circle_plot = list(teal_transform_module(...)) # applied only to `circle_plot` output
-#'      biplot = list(teal_transform_module(...)) # applied only to `biplot` output
-#'      eigenvector_plot = list(teal_transform_module(...)) # applied only to `eigenvector_plot` output
+#'      elbow_plot = teal_transform_module(...), # applied to the `elbow_plot` output
+#'      circle_plot = teal_transform_module(...), # applied to the `circle_plot` output
+#'      biplot = teal_transform_module(...), # applied to the `biplot` output
+#'      eigenvector_plot = teal_transform_module(...) # applied to the `eigenvector_plot` output
 #'    )
 #' )
 #' ```
@@ -186,9 +184,7 @@ tm_a_pca <- function(label = "Principal Component Analysis",
   checkmate::assert_multi_class(post_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
 
   available_decorators <- c("elbow_plot", "circle_plot", "biplot", "eigenvector_plot")
-  decorators <- normalize_decorators(decorators)
   assert_decorators(decorators, available_decorators)
-  # End of assertions
 
   # Make UI args
   args <- as.list(environment())

R/tm_a_regression.R

@@ -48,6 +48,19 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`ggplot2`)
 #'
+#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
+#' The name of this list corresponds to the name of the output to which the decorator is applied.
+#' See code snippet below:
+#'
+#' ```
+#' tm_a_regression(
+#'    ..., # arguments for module
+#'    decorators = list(
+#'      plot = teal_transform_module(...) # applied to the `plot` output
+#'    )
+#' )
+#' ```
+#'
 #' For additional details and examples of decorators, refer to the vignette
 #' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
@@ -225,7 +238,6 @@ tm_a_regression <- function(label = "Regression Analysis",
       .var.name = "label_segment_threshold"
     )
   }
-  decorators <- normalize_decorators(decorators)
   assert_decorators(decorators, "plot")
   # End of assertions
 

R/tm_g_association.R

@@ -29,6 +29,19 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`grob` created with [ggplot2::ggplotGrob()])
 #'
+#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
+#' The name of this list corresponds to the name of the output to which the decorator is applied.
+#' See code snippet below:
+#'
+#' ```
+#' tm_g_association(
+#'    ..., # arguments for module
+#'    decorators = list(
+#'      plot = teal_transform_module(...) # applied to the `plot` output
+#'    )
+#' )
+#' ```
+#'
 #' For additional details and examples of decorators, refer to the vignette
 #' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
@@ -176,7 +189,6 @@ tm_g_association <- function(label = "Association",
   checkmate::assert_list(ggplot2_args, types = "ggplot2_args")
   checkmate::assert_subset(names(ggplot2_args), c("default", plot_choices))
 
-  decorators <- normalize_decorators(decorators)
   assert_decorators(decorators, "plot")
   # End of assertions
 

R/tm_g_bivariate.R

@@ -51,6 +51,19 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`ggplot2`)
 #'
+#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
+#' The name of this list corresponds to the name of the output to which the decorator is applied.
+#' See code snippet below:
+#'
+#' ```
+#' tm_g_bivariate(
+#'    ..., # arguments for module
+#'    decorators = list(
+#'      plot = teal_transform_module(...) # applied to the `plot` output
+#'    )
+#' )
+#' ```
+#'
 #' For additional details and examples of decorators, refer to the vignette
 #' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
@@ -277,7 +290,6 @@ tm_g_bivariate <- function(label = "Bivariate Plots",
   checkmate::assert_multi_class(pre_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
   checkmate::assert_multi_class(post_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
 
-  decorators <- normalize_decorators(decorators)
   assert_decorators(decorators, "plot")
   # End of assertions
 

R/tm_g_distribution.R

@@ -34,20 +34,18 @@
 #' - `summary_table` (`listing_df` created with [rlistings::as_listing()])
 #' - `test_table` (`listing_df` created with [rlistings::as_listing()])
 #'
-#' Decorators can be applied to all outputs or only to specific objects using a
-#' named list of `teal_transform_module` objects.
-#' The `"default"` name is reserved for decorators that are applied to all outputs.
+#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
+#' The name of this list corresponds to the name of the output to which the decorator is applied.
 #' See code snippet below:
 #'
 #' ```
 #' tm_g_distribution(
 #'    ..., # arguments for module
 #'    decorators = list(
-#'      default = list(teal_transform_module(...)), # applied to all outputs
-#'      histogram_plot = list(teal_transform_module(...)), # applied only to `histogram_plot` output
-#'      qq_plot = list(teal_transform_module(...)) # applied only to `qq_plot` output
-#'      summary_table = list(teal_transform_module(...)) # applied only to `summary_table` output
-#'      test_table = list(teal_transform_module(...)) # applied only to `test_table` output
+#'      histogram_plot = teal_transform_module(...), # applied only to `histogram_plot` output
+#'      qq_plot = teal_transform_module(...), # applied only to `qq_plot` output
+#'      summary_table = teal_transform_module(...), # applied only to `summary_table` output
+#'      test_table = teal_transform_module(...) # applied only to `test_table` output
 #'    )
 #' )
 #' ```
@@ -194,7 +192,6 @@ tm_g_distribution <- function(label = "Distribution Module",
   checkmate::assert_multi_class(post_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
 
   available_decorators <- c("histogram_plot", "qq_plot", "test_table", "summary_table")
-  decorators <- normalize_decorators(decorators)
   assert_decorators(decorators, names = available_decorators)
 
   # End of assertions

R/tm_g_response.R

@@ -44,6 +44,19 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`ggplot2`)
 #'
+#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
+#' The name of this list corresponds to the name of the output to which the decorator is applied.
+#' See code snippet below:
+#'
+#' ```
+#' tm_g_response(
+#'    ..., # arguments for module
+#'    decorators = list(
+#'      plot = teal_transform_module(...) # applied to the `plot` output
+#'    )
+#' )
+#' ```
+#'
 #' For additional details and examples of decorators, refer to the vignette
 #' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
@@ -202,7 +215,6 @@ tm_g_response <- function(label = "Response Plot",
   checkmate::assert_multi_class(pre_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
   checkmate::assert_multi_class(post_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
 
-  decorators <- normalize_decorators(decorators)
   assert_decorators(decorators, "plot")
   # End of assertions
 

R/tm_g_scatterplot.R

@@ -35,6 +35,19 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`ggplot2`)
 #'
+#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
+#' The name of this list corresponds to the name of the output to which the decorator is applied.
+#' See code snippet below:
+#'
+#' ```
+#' tm_g_scatterplot(
+#'    ..., # arguments for module
+#'    decorators = list(
+#'      plot = teal_transform_module(...) # applied to the `plot` output
+#'    )
+#' )
+#' ```
+#'
 #' For additional details and examples of decorators, refer to the vignette
 #' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
@@ -299,7 +312,6 @@ tm_g_scatterplot <- function(label = "Scatterplot",
   checkmate::assert_scalar(table_dec)
   checkmate::assert_class(ggplot2_args, "ggplot2_args")
 
-  decorators <- normalize_decorators(decorators)
   assert_decorators(decorators, "plot")
 
   # End of assertions

R/tm_g_scatterplotmatrix.R

@@ -23,6 +23,19 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`trellis` - output of `lattice::splom`)
 #'
+#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
+#' The name of this list corresponds to the name of the output to which the decorator is applied.
+#' See code snippet below:
+#'
+#' ```
+#' tm_g_scatterplotmatrix(
+#'    ..., # arguments for module
+#'    decorators = list(
+#'      plot = teal_transform_module(...) # applied to the `plot` output
+#'    )
+#' )
+#' ```
+#'
 #' For additional details and examples of decorators, refer to the vignette
 #' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
@@ -199,7 +212,6 @@ tm_g_scatterplotmatrix <- function(label = "Scatterplot Matrix",
   checkmate::assert_multi_class(pre_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
   checkmate::assert_multi_class(post_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
 
-  decorators <- normalize_decorators(decorators)
   assert_decorators(decorators, "plot")
   # End of assertions