Add vignettes on decorators

R/tm_a_pca.R

@@ -43,8 +43,9 @@
 #' )
 #' ```
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
 #' library(teal.modules.general)

R/tm_a_regression.R

@@ -48,8 +48,9 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`ggplot2`)
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
 #' library(teal.modules.general)

R/tm_g_association.R

@@ -29,8 +29,9 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`grob` created with [ggplot2::ggplotGrob()])
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
 #' library(teal.modules.general)

R/tm_g_bivariate.R

@@ -51,8 +51,9 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`ggplot2`)
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #'
 #' @examplesShinylive

R/tm_g_distribution.R

@@ -52,8 +52,9 @@
 #' )
 #' ```
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
 #' library(teal.modules.general)

R/tm_g_response.R

@@ -44,8 +44,9 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`ggplot2`)
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
 #' library(teal.modules.general)

R/tm_g_scatterplot.R

@@ -35,8 +35,9 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`ggplot2`)
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #'
 #' @examplesShinylive

R/tm_g_scatterplotmatrix.R

@@ -23,8 +23,9 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `plot` (`trellis` - output of `lattice::splom`)
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
 #' library(teal.modules.general)

R/tm_missing_data.R

@@ -43,8 +43,9 @@
 #' )
 #' ```
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
 #' library(teal.modules.general)

R/tm_outliers.R

@@ -41,8 +41,9 @@
 #' )
 #' ```
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
 #' library(teal.modules.general)

R/tm_t_crosstable.R

@@ -30,8 +30,9 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `table` (`ElementaryTable` - output of `rtables::build_table`)
 #'
-#' For additional details and examples of decorators, refer to the vignette
-#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
+#' For additional details and examples of decorators, refer to the vignettes:
+#' `vignette("customizing-module-output, package = "teal.modules.general")`,
+#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
 #' library(teal.modules.general)

R/utils.R

@@ -34,9 +34,10 @@
 #' - 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`) optional,
+#' (`list` of `teal_transform_module`, named `list` of lists of `teal_transform_module`) optional,
 #' decorator for tables or plots included in the module output reported.
 #' When a named list of `teal_transform_module`, the decorators are applied to the respective output objects.
+#' Either all named or all unnamed decorators need to be passed.
 #'
 #' Otherwise, the decorators are applied to all objects, which is equivalent as using the name `default`.
 #'