Skip to content

Commit bb52cf6

Browse files
committed
docs: update docs on other complex modules with more than 1 decorateable output
1 parent 2f9f79b commit bb52cf6

File tree

6 files changed

+76
-6
lines changed

6 files changed

+76
-6
lines changed

R/tm_g_distribution.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@
4444
#' ..., # arguments for module
4545
#' decorators = list(
4646
#' default = list(teal_transform_module(...)), # applied to all outputs
47-
#' plot = list(teal_transform_module(...)), # applied only to plot output (histogram plot)
48-
#' test_table = list(teal_transform_module(...)) # applied only to test_table
49-
#' summary_table = list(teal_transform_module(...)) # applied only to summary_table
47+
#' plot = list(teal_transform_module(...)), # applied only to `plot` output (histogram plot)
48+
#' test_table = list(teal_transform_module(...)) # applied only to `test_table` output
49+
#' summary_table = list(teal_transform_module(...)) # applied only to `summary_table` output
5050
#' )
5151
#' )
5252
#' ```

R/tm_missing_data.R

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,24 @@
2525
#' - `by_subject_plot` (`ggplot2`)
2626
#' - `table` ([DT::datatable()])
2727
#'
28+
#' Decorators can be applied to all outputs or only to specific objects using a
29+
#' named list of `teal_transform_module` objects.
30+
#' The `"default"` name is reserved for decorators that are applied to all outputs.
31+
#' See code snippet below:
32+
#'
33+
#' ```
34+
#' tm_missing_data(
35+
#' ..., # arguments for module
36+
#' decorators = list(
37+
#' default = list(teal_transform_module(...)), # applied to all outputs
38+
#' summary_plot = list(teal_transform_module(...)), # applied only to `summary_plot` output
39+
#' combination_plot = list(teal_transform_module(...)) # applied only to `combination_plot` output
40+
#' by_subject_plot = list(teal_transform_module(...)) # applied only to `by_subject_plot` output
41+
#' table = list(teal_transform_module(...)) # applied only to `table` output
42+
#' )
43+
#' )
44+
#' ```
45+
#'
2846
#' For additional details and examples of decorators, refer to the vignette
2947
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
3048
#'

R/tm_outliers.R

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,24 @@
2424
#' - `cumulative_plot` (`ggplot2`)
2525
#' - `table` ([DT::datatable()])
2626
#'
27+
#' Decorators can be applied to all outputs or only to specific objects using a
28+
#' named list of `teal_transform_module` objects.
29+
#' The `"default"` name is reserved for decorators that are applied to all outputs.
30+
#' See code snippet below:
31+
#'
32+
#' ```
33+
#' tm_outliers(
34+
#' ..., # arguments for module
35+
#' decorators = list(
36+
#' default = list(teal_transform_module(...)), # applied to all outputs
37+
#' box_plot = list(teal_transform_module(...)), # applied only to `box_plot` output
38+
#' density_plot = list(teal_transform_module(...)) # applied only to `density_plot` output
39+
#' cumulative_plot = list(teal_transform_module(...)) # applied only to `cumulative_plot` output
40+
#' table = list(teal_transform_module(...)) # applied only to `table` output
41+
#' )
42+
#' )
43+
#' ```
44+
#'
2745
#' For additional details and examples of decorators, refer to the vignette
2846
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
2947
#'

man/tm_g_distribution.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_missing_data.Rd

Lines changed: 17 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_outliers.Rd

Lines changed: 17 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)