Skip to content

Commit ce8df21

Browse files
committed
chore: add note in decorated documentation and generate man pages
1 parent c6c4c17 commit ce8df21

File tree

6 files changed

+20
-4
lines changed

6 files changed

+20
-4
lines changed

R/tm_g_distribution.R

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,9 @@
3232
#' - `histogram_plot` (`ggplot`)
3333
#' - `qq_plot` (`ggplot`)
3434
#' - `summary_table` (`ElementaryTable` created with [rtables::df_to_tt()])
35+
#' - The decorated table is only shown in the reporter as it is presented as an interactive DataTable in the module.
3536
#' - `test_table` (`ElementaryTable` created with [rtables::df_to_tt()])
37+
#' - The decorated table is only shown in the reporter as it is presented as an interactive DataTable in the module.
3638
#'
3739
#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
3840
#' The name of this list corresponds to the name of the output to which the decorator is applied.

R/tm_missing_data.R

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
#' - `combination_plot` (`grob` created with [ggplot2::ggplotGrob()])
2525
#' - `by_subject_plot` (`ggplot`)
2626
#' - `table` (`ElementaryTable` created with [rtables::df_to_tt()])
27+
#' - The decorated table is only shown in the reporter as it is presented as an interactive DataTable in the module.
2728
#'
2829
#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
2930
#' The name of this list corresponds to the name of the output to which the decorator is applied.

R/tm_outliers.R

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
#' - `density_plot` (`ggplot`)
2323
#' - `cumulative_plot` (`ggplot`)
2424
#' - `table` (`ElementaryTable` created with [rtables::df_to_tt()])
25+
#' - The decorated table is only shown in the reporter as it is presented as an interactive DataTable in the module.
2526
#'
2627
#' A Decorator is applied to the specific output using a named list of `teal_transform_module` objects.
2728
#' The name of this list corresponds to the name of the output to which the decorator is applied.

man/tm_g_distribution.Rd

Lines changed: 8 additions & 2 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: 4 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/tm_outliers.Rd

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

0 commit comments

Comments
 (0)