docs: remove custom decorators parameter

R/roxygen2_templates.R

@@ -1,18 +1,4 @@
 # nocov start
-roxygen_decorators_param <- function(module_name) {
-  paste(
-    sep = " ",
-    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.",
-    "When a named list of `teal_transform_module`, the decorators are applied to the",
-    "respective output objects.\n\n",
-    "Otherwise, the decorators are applied to all objects, which is equivalent as using the name `default`.\n\n",
-    sprintf("See section \"Decorating `%s`\"", module_name),
-    "below for more details."
-  )
-}
-
 roxygen_ggplot2_args_param <- function(...) {
   paste(
     sep = " ",

R/tm_a_pca.R

@@ -14,7 +14,6 @@
 #' - If vector of `length == 1` then the font sizes will have a fixed size.
 #' - while vector of `value`, `min`, and `max` allows dynamic adjustment.
 #' @param ggplot2_args `r roxygen_ggplot2_args_param("Elbow plot", "Circle plot", "Biplot", "Eigenvector plot")`
-#' @param decorators `r roxygen_decorators_param("tm_a_pca")`
 #'
 #' @inherit shared_params return
 #'

R/tm_a_regression.R

@@ -40,7 +40,6 @@
 # nolint start: line_length.
 #' @param ggplot2_args `r roxygen_ggplot2_args_param("Response vs Regressor", "Residuals vs Fitted", "Scale-Location", "Cook's distance", "Residuals vs Leverage", "Cook's dist vs Leverage")`
 # nolint end: line_length.
-#' @param decorators `r roxygen_decorators_param("tm_a_regression")`
 #'
 #' @inherit shared_params return
 #'

R/tm_data_table.R

@@ -26,7 +26,6 @@
 #' `list(searching = FALSE, pageLength = 30, lengthMenu = c(5, 15, 30, 100), scrollX = TRUE)`
 #' @param server_rendering (`logical`) should the data table be rendered server side
 #' (see `server` argument of [DT::renderDataTable()])
-#' @param decorators `r roxygen_decorators_param("tm_data_table")`
 #'
 #' @inherit shared_params return
 #'

R/tm_g_association.R

@@ -21,7 +21,6 @@
 #' Default to `"gray"`.
 #'
 #' @param ggplot2_args `r roxygen_ggplot2_args_param("Bivariate1", "Bivariate2")`
-#' @param decorators `r roxygen_decorators_param("tm_g_association")`
 #'
 #' @inherit shared_params return
 #'

R/tm_g_bivariate.R

@@ -43,7 +43,6 @@
 #' @param free_y_scales (`logical`) optional, whether Y scaling shall be changeable.
 #' Does not allow scaling to be changed by default (`FALSE`).
 #' @param swap_axes (`logical`) optional, whether to swap X and Y axes. Defaults to `FALSE`.
-#' @param decorators `r roxygen_decorators_param("tm_g_bivariate")`
 #'
 #' @inherit shared_params return
 #'

R/tm_g_distribution.R

@@ -23,7 +23,6 @@
 #' Defaults to `c(30L, 1L, 100L)`.
 #'
 #' @param ggplot2_args `r roxygen_ggplot2_args_param("Histogram", "QQplot")`
-#' @param decorators `r roxygen_decorators_param("tm_g_distribution")`
 #'
 #' @inherit shared_params return
 #'

R/tm_g_response.R

@@ -33,7 +33,6 @@
 #' @param freq (`logical(1)`)
 #' Indicates whether to display frequency (`TRUE`) or density (`FALSE`).
 #' Defaults to density (`FALSE`).
-#' @param decorators `r roxygen_decorators_param("tm_g_response")`
 #'
 #' @inherit shared_params return
 #'

R/tm_g_scatterplot.R

@@ -27,7 +27,6 @@
 #' `vignette("ggplot2-specs", package="ggplot2")`.
 #' @param max_deg (`integer`) optional, maximum degree for the polynomial trend line. Must not be less than 1.
 #' @param table_dec (`integer`) optional, number of decimal places used to round numeric values in the table.
-#' @param decorators `r roxygen_decorators_param("tm_g_scatterplot")`
 #'
 #' @inherit shared_params return
 #'

R/tm_g_scatterplotmatrix.R

@@ -15,7 +15,6 @@
 #' Specifies plotting variables from an incoming dataset with filtering and selecting. In case of
 #' `data_extract_spec` use `select_spec(..., ordered = TRUE)` if plot elements should be
 #' rendered according to selection order.
-#' @param decorators `r roxygen_decorators_param("tm_g_scatterplotmatrix")`
 #'
 #' @inherit shared_params return
 #'

R/tm_missing_data.R

@@ -14,7 +14,6 @@
 #' @param ggtheme (`character`) optional, specifies the default `ggplot2` theme for plots. Defaults to `classic`.
 #' @param ggplot2_args `r roxygen_ggplot2_args_param("Summary Obs", "Summary Patients", "Combinations Main", "Combinations Hist", "By Subject")`
 # nolint end: line_length.
-#' @param decorators `r roxygen_decorators_param("tm_missing_data")`
 #'
 #' @inherit shared_params return
 #'

R/tm_outliers.R

@@ -12,7 +12,6 @@
 #' @param categorical_var (`data_extract_spec` or `list` of multiple `data_extract_spec`) optional,
 #' specifies the categorical variable(s) to split the selected outlier variables on.
 #' @param ggplot2_args `r roxygen_ggplot2_args_param("Boxplot", "Density Plot", "Cumulative Distribution Plot")`
-#' @param decorators `r roxygen_decorators_param("tm_outliers")`
 #'
 #' @inherit shared_params return
 #'

R/tm_t_crosstable.R

@@ -19,7 +19,6 @@
 #' @param show_total (`logical(1)`)
 #' Indicates whether to show total column.
 #' Defaults to `TRUE`.
-#' @param decorators `r roxygen_decorators_param("tm_t_crosstable")`
 #'
 #' @note For more examples, please see the vignette "Using cross table" via
 #' `vignette("using-cross-table", package = "teal.modules.general")`.

R/utils.R

@@ -33,6 +33,14 @@
 #' - When the length of `size` is one: the plot point sizes will have a fixed size.
 #' - 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.
+#' 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`.
+#'
+#' See section "Decorating Module" below for more details.
 #'
 #' @return Object of class `teal_module` to be used in `teal` applications.
 #'