Add vignettes on decorators (#843)

Part of insightsengineering/teal#1475

Adds some explanation about decorators functionality of `tmg`, since we
will remove/reduce confusing decorators vignette in `teal`. Heavily
based on `Customizing Module Output` vignette currently existing in
`teal`, with adjustments to show `teal.modules.general` modules.


https://github.com/insightsengineering/teal/blob/c70299587cdf8280c75f7320ae09cd3c67c79837/vignettes/customizing-module-output.Rmd

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: vedhav <vedhaviyash4@gmail.com>
Co-authored-by: Vedha Viyash <49812166+vedhav@users.noreply.github.com>

Author: 3 people

R/tm_a_pca.R

@@ -20,10 +20,10 @@
 #' @section Decorating Module:
 #'
 #' This module generates the following objects, which can be modified in place using decorators:
-#' - `elbow_plot` (`ggplot2`)
-#' - `circle_plot` (`ggplot2`)
-#' - `biplot` (`ggplot2`)
-#' - `eigenvector_plot` (`ggplot2`)
+#' - `elbow_plot` (`ggplot`)
+#' - `circle_plot` (`ggplot`)
+#' - `biplot` (`ggplot`)
+#' - `eigenvector_plot` (`ggplot`)
 #'
 #' 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.
@@ -42,6 +42,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive

R/tm_a_regression.R

@@ -46,7 +46,7 @@
 #' @section Decorating Module:
 #'
 #' This module generates the following objects, which can be modified in place using decorators:
-#' - `plot` (`ggplot2`)
+#' - `plot` (`ggplot`)
 #'
 #' 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.
@@ -62,6 +62,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive

R/tm_g_association.R

@@ -43,6 +43,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive

R/tm_g_bivariate.R

@@ -49,7 +49,7 @@
 #' @section Decorating Module:
 #'
 #' This module generates the following objects, which can be modified in place using decorators:
-#' - `plot` (`ggplot2`)
+#' - `plot` (`ggplot`)
 #'
 #' 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.
@@ -65,6 +65,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #'

R/tm_g_distribution.R

@@ -29,8 +29,8 @@
 #' @section Decorating Module:
 #'
 #' This module generates the following objects, which can be modified in place using decorators::
-#' - `histogram_plot` (`ggplot2`)
-#' - `qq_plot` (`ggplot2`)
+#' - `histogram_plot` (`ggplot`)
+#' - `qq_plot` (`ggplot`)
 #' - `summary_table` (`datatables` created with [DT::datatable()])
 #' - `test_table` (`datatables` created with [DT::datatable()])
 #'
@@ -51,6 +51,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive

R/tm_g_response.R

@@ -42,7 +42,7 @@
 #' @section Decorating Module:
 #'
 #' This module generates the following objects, which can be modified in place using decorators:
-#' - `plot` (`ggplot2`)
+#' - `plot` (`ggplot`)
 #'
 #' 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.
@@ -58,6 +58,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive

R/tm_g_scatterplot.R

@@ -33,7 +33,7 @@
 #' @section Decorating Module:
 #'
 #' This module generates the following objects, which can be modified in place using decorators:
-#' - `plot` (`ggplot2`)
+#' - `plot` (`ggplot`)
 #'
 #' 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.
@@ -49,6 +49,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #'

R/tm_g_scatterplotmatrix.R

@@ -37,6 +37,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive

R/tm_missing_data.R

@@ -22,8 +22,8 @@
 #' This module generates the following objects, which can be modified in place using decorators:
 #' - `summary_plot` (`grob` created with [ggplot2::ggplotGrob()])
 #' - `combination_plot` (`grob` created with [ggplot2::ggplotGrob()])
-#' - `by_subject_plot` (`ggplot2`)
-#' - `table` (`datatable` created with [DT::datatable()])
+#' - `by_subject_plot` (`ggplot`)
+#' - `table` (`datatables` created with [DT::datatable()])
 #'
 #' 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.
@@ -42,6 +42,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive

R/tm_outliers.R

@@ -18,10 +18,10 @@
 #' @section Decorating Module:
 #'
 #' This module generates the following objects, which can be modified in place using decorators:
-#' - `box_plot` (`ggplot2`)
-#' - `density_plot` (`ggplot2`)
-#' - `cumulative_plot` (`ggplot2`)
-#' - `table` (`datatable` created with [DT::datatable()])
+#' - `box_plot` (`ggplot`)
+#' - `density_plot` (`ggplot`)
+#' - `cumulative_plot` (`ggplot`)
+#' - `table` (`datatables` created with [DT::datatable()])
 #'
 #' 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.
@@ -40,6 +40,9 @@
 #' ```
 #'
 #' For additional details and examples of decorators, refer to the vignette
+#' `vignette("decorate-module-output", package = "teal.modules.general")`.
+#'
+#' To learn more please refer to the vignette
 #' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
 #'
 #' @examplesShinylive
@@ -533,12 +536,12 @@ srv_outliers <- function(id, data, reporter, filter_panel_api, outlier_var,
       # this is utils function that converts a %>% NULL %>% b into a %>% b
       remove_pipe_null <- function(x) {
         if (length(x) == 1) {
-          return(x)
-        }
-        if (identical(x[[1]], as.name("%>%")) && is.null(x[[3]])) {
-          return(remove_pipe_null(x[[2]]))
+          x
+        } else if (identical(x[[1]], as.name("%>%")) && is.null(x[[3]])) {
+          remove_pipe_null(x[[2]])
+        } else {
+          as.call(c(x[[1]], lapply(x[-1], remove_pipe_null)))
         }
-        return(as.call(c(x[[1]], lapply(x[-1], remove_pipe_null))))
       }
 
       qenv <- teal.code::eval_code(