Skip to content

update info on where to learn about decorators #1342

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

update info on where to learn about decorators #1342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f925d5
update info about where to look for information about decorators
m7pr Feb 12, 2025
7293b5d
[skip roxygen] [skip vbump] Roxygen Man Pages Auto Update
github-actions[bot] Feb 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions DESCRIPTION
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ Suggests:
styler,
testthat (>= 3.1.5),
withr (> 2.0.1.5)
Linking:
teal.modules.general
Copy link
Contributor Author

@m7pr m7pr Feb 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vedhav do you think we need a separate vignette in tmc, or is it fine just to link to the vignette in tmg?

VignetteBuilder:
knitr,
rmarkdown
Expand Down
5 changes: 3 additions & 2 deletions R/tm_a_gee.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,9 @@ template_a_gee <- function(output_table,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`ElementaryTable` - output of `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_barchart_simple.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,9 @@
#' This module generates the following objects, which can be modified in place using decorators:
#' - `plot` (`ggplot2`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_ci.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -194,8 +194,9 @@ template_g_ci <- function(dataname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `plot` (`ggplot2`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_forest_rsp.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,9 @@ template_forest_rsp <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `plot` (`ggplot2`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_forest_tte.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,8 +249,9 @@ template_forest_tte <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `plot` (`ggplot2`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_ipp.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,9 @@ template_g_ipp <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `plot` (`ggplot2`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#'
#' @examplesShinylive
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_km.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,9 @@ template_g_km <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `plot` (`ggplot2`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#'
#' @examplesShinylive
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_lineplot.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -220,8 +220,9 @@ template_g_lineplot <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `plot` (`ggplot2`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_pp_adverse_events.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,8 +206,9 @@ template_adverse_events <- function(dataname = "ANL",
#' )
#' ```
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_pp_patient_timeline.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,8 +353,9 @@ template_patient_timeline <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `plot` (`ggplot2`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#'
#' @examplesShinylive
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_pp_therapy.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -267,8 +267,9 @@ template_therapy <- function(dataname = "ANL",
#' )
#' ```
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_g_pp_vitals.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,8 +215,9 @@ template_vitals <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `plot` (`ggplot2`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#'
#' @examplesShinylive
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_abnormality.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,8 +242,9 @@ template_abnormality <- function(parentname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`ElementaryTable` - output of `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @note Patients with the same abnormality at baseline as on the treatment visit can be
#' excluded in accordance with GDSR specifications by using `exclude_base_abn`.
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_abnormality_by_worst_grade.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,8 +254,9 @@ template_abnormality_by_worst_grade <- function(parentname, # nolint: object_len
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`ElementaryTable` - output of `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @export
#'
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_ancova.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,8 +430,9 @@ template_ancova <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`ElementaryTable` - output of `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @details
#' When a single endpoint is selected, both unadjusted and adjusted comparison are provided. This modules
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_binary_outcome.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -356,8 +356,9 @@ template_binary_outcome <- function(dataname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`TableTree` - output of `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_coxreg.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,8 +366,9 @@ template_coxreg_m <- function(dataname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`TableTree` as created from `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_events.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,8 +467,9 @@ template_events <- function(dataname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`TableTree` as created from `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_events_by_grade.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -786,8 +786,9 @@ template_events_col_by_grade <- function(dataname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`TableTree` as created from `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @export
#'
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_events_patyear.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,8 +198,9 @@ template_events_patyear <- function(dataname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`TableTree` as created from `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#'
#' @examples
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_events_summary.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -528,8 +528,9 @@ template_events_summary <- function(anl_name,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`TableTree` as created from `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_exposure.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,8 +232,9 @@ template_exposure <- function(parentname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`TableTree` as created from `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_logistic.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,8 +227,9 @@ template_logistic <- function(dataname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`ElementaryTable` - output of `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_mult_events.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -290,8 +290,9 @@ template_mult_events <- function(dataname,
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`TableTree` - output of `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_pp_basic_info.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,9 @@ template_basic_info <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`listing_df` - output of `rlistings::as_listing`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_pp_laboratory.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,8 +159,9 @@ template_laboratory <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`listing_df` - output of `rlistings::as_listing`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
5 changes: 3 additions & 2 deletions R/tm_t_pp_medical_history.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,9 @@ template_medical_history <- function(dataname = "ANL",
#' This module generates the following objects, which can be modified in place using decorators:
#' - `table` (`TableTree` - output of `rtables::build_table`)
#'
#' For additional details and examples of decorators, refer to the vignette
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation.
#' For additional details and examples of decorators, refer to the vignettes:
#' `vignette("decorate-module-output, package = "teal.modules.general")`,
#' `vignette("transform-module-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
#'
#' @examplesShinylive
#' library(teal.modules.clinical)
Expand Down
Loading
Loading