Skip to content

Commit e13dc89

Browse files
committed
docs: remove custom decorators parameter
1 parent b8c4674 commit e13dc89

32 files changed

+172
-53
lines changed

R/roxygen2_templates.R

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,4 @@
11
# nocov start
2-
roxygen_decorators_param <- function(module_name) {
3-
paste(
4-
sep = " ",
5-
lifecycle::badge("experimental"),
6-
" (`list` of `teal_transform_module`, named `list` of `teal_transform_module` or",
7-
"`NULL`) optional, if not `NULL`, decorator for tables or plots included in the module.",
8-
"When a named list of `teal_transform_module`, the decorators are applied to the",
9-
"respective output objects.\n\n",
10-
"Otherwise, the decorators are applied to all objects, which is equivalent as using the name `default`.\n\n",
11-
sprintf("See section \"Decorating `%s`\"", module_name),
12-
"below for more details."
13-
)
14-
}
15-
162
roxygen_ggplot2_args_param <- function(...) {
173
paste(
184
sep = " ",

R/tm_a_pca.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@
1414
#' - If vector of `length == 1` then the font sizes will have a fixed size.
1515
#' - while vector of `value`, `min`, and `max` allows dynamic adjustment.
1616
#' @param ggplot2_args `r roxygen_ggplot2_args_param("Elbow plot", "Circle plot", "Biplot", "Eigenvector plot")`
17-
#' @param decorators `r roxygen_decorators_param("tm_a_pca")`
1817
#'
1918
#' @inherit shared_params return
2019
#'

R/tm_a_regression.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@
4040
# nolint start: line_length.
4141
#' @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")`
4242
# nolint end: line_length.
43-
#' @param decorators `r roxygen_decorators_param("tm_a_regression")`
4443
#'
4544
#' @inherit shared_params return
4645
#'

R/tm_data_table.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@
2626
#' `list(searching = FALSE, pageLength = 30, lengthMenu = c(5, 15, 30, 100), scrollX = TRUE)`
2727
#' @param server_rendering (`logical`) should the data table be rendered server side
2828
#' (see `server` argument of [DT::renderDataTable()])
29-
#' @param decorators `r roxygen_decorators_param("tm_data_table")`
3029
#'
3130
#' @inherit shared_params return
3231
#'

R/tm_g_association.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
#' Default to `"gray"`.
2222
#'
2323
#' @param ggplot2_args `r roxygen_ggplot2_args_param("Bivariate1", "Bivariate2")`
24-
#' @param decorators `r roxygen_decorators_param("tm_g_association")`
2524
#'
2625
#' @inherit shared_params return
2726
#'

R/tm_g_bivariate.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,6 @@
4343
#' @param free_y_scales (`logical`) optional, whether Y scaling shall be changeable.
4444
#' Does not allow scaling to be changed by default (`FALSE`).
4545
#' @param swap_axes (`logical`) optional, whether to swap X and Y axes. Defaults to `FALSE`.
46-
#' @param decorators `r roxygen_decorators_param("tm_g_bivariate")`
4746
#'
4847
#' @inherit shared_params return
4948
#'

R/tm_g_distribution.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@
2323
#' Defaults to `c(30L, 1L, 100L)`.
2424
#'
2525
#' @param ggplot2_args `r roxygen_ggplot2_args_param("Histogram", "QQplot")`
26-
#' @param decorators `r roxygen_decorators_param("tm_g_distribution")`
2726
#'
2827
#' @inherit shared_params return
2928
#'

R/tm_g_response.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333
#' @param freq (`logical(1)`)
3434
#' Indicates whether to display frequency (`TRUE`) or density (`FALSE`).
3535
#' Defaults to density (`FALSE`).
36-
#' @param decorators `r roxygen_decorators_param("tm_g_response")`
3736
#'
3837
#' @inherit shared_params return
3938
#'

R/tm_g_scatterplot.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
#' `vignette("ggplot2-specs", package="ggplot2")`.
2828
#' @param max_deg (`integer`) optional, maximum degree for the polynomial trend line. Must not be less than 1.
2929
#' @param table_dec (`integer`) optional, number of decimal places used to round numeric values in the table.
30-
#' @param decorators `r roxygen_decorators_param("tm_g_scatterplot")`
3130
#'
3231
#' @inherit shared_params return
3332
#'

R/tm_g_scatterplotmatrix.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@
1515
#' Specifies plotting variables from an incoming dataset with filtering and selecting. In case of
1616
#' `data_extract_spec` use `select_spec(..., ordered = TRUE)` if plot elements should be
1717
#' rendered according to selection order.
18-
#' @param decorators `r roxygen_decorators_param("tm_g_scatterplotmatrix")`
1918
#'
2019
#' @inherit shared_params return
2120
#'

0 commit comments

Comments
 (0)