From 0732f7605df5831d758554431dffeacc75607e60 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Llu=C3=ADs=20Revilla?= Date: Mon, 17 Nov 2025 13:49:40 +0100 Subject: [PATCH 1/4] Increment version number to 0.12.0 --- DESCRIPTION | 7 ++----- NEWS.md | 2 +- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 3c01faa17..867ccc4f9 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: teal.modules.clinical Title: 'teal' Modules for Standard Clinical Outputs -Version: 0.11.1.9014 -Date: 2025-11-13 +Version: 0.12.0 +Date: 2025-11-17 Authors@R: c( person("Joe", "Zhu", , "joe.zhu@roche.com", role = "aut", comment = c(ORCID = "0000-0001-7566-2787")), @@ -82,9 +82,6 @@ Suggests: VignetteBuilder: knitr, rmarkdown -Remotes: - insightsengineering/teal, - insightsengineering/teal.reporter Config/Needs/verdepcheck: insightsengineering/teal, insightsengineering/teal.slice, insightsengineering/teal.transform, insightsengineering/tern, tidymodels/broom, mllg/checkmate, diff --git a/NEWS.md b/NEWS.md index f7f9a7dbd..143616169 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# teal.modules.clinical 0.11.1.9014 +# teal.modules.clinical 0.12.0 ### Enhancements * Modules return a `teal_report` object that contains the data, code and report. All the reporter buttons were removed from the modules' UI in favor of the framework level reporter buttons (#1376). From c5de3e9884a296701eef40ac3798756df6b4ba55 Mon Sep 17 00:00:00 2001 From: Dony Unardi Date: Tue, 2 Dec 2025 10:34:38 -0800 Subject: [PATCH 2/4] [skip vbump] upversion 0.12.0 --- DESCRIPTION | 11 ++++------- NEWS.md | 2 +- 2 files changed, 5 insertions(+), 8 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 3c01faa17..ac12e6b57 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: teal.modules.clinical Title: 'teal' Modules for Standard Clinical Outputs -Version: 0.11.1.9014 -Date: 2025-11-13 +Version: 0.12.0 +Date: 2025-12-02 Authors@R: c( person("Joe", "Zhu", , "joe.zhu@roche.com", role = "aut", comment = c(ORCID = "0000-0001-7566-2787")), @@ -33,7 +33,7 @@ BugReports: https://github.com/insightsengineering/teal.modules.clinical/issues Depends: R (>= 4.4), - teal (>= 1.0.0.9003), + teal (>= 1.1), teal.transform (>= 0.7.0), tern (>= 0.9.9) Imports: @@ -60,7 +60,7 @@ Imports: teal.code (>= 0.7.0), teal.data (>= 0.8.0), teal.logger (>= 0.4.0), - teal.reporter (>= 0.5.0.9001), + teal.reporter (>= 0.6.0), teal.widgets (>= 0.5.0), tern.gee (>= 0.1.5), tern.mmrm (>= 0.3.3), @@ -82,9 +82,6 @@ Suggests: VignetteBuilder: knitr, rmarkdown -Remotes: - insightsengineering/teal, - insightsengineering/teal.reporter Config/Needs/verdepcheck: insightsengineering/teal, insightsengineering/teal.slice, insightsengineering/teal.transform, insightsengineering/tern, tidymodels/broom, mllg/checkmate, diff --git a/NEWS.md b/NEWS.md index f7f9a7dbd..143616169 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# teal.modules.clinical 0.11.1.9014 +# teal.modules.clinical 0.12.0 ### Enhancements * Modules return a `teal_report` object that contains the data, code and report. All the reporter buttons were removed from the modules' UI in favor of the framework level reporter buttons (#1376). From f9e846446e6c52357d6b3b604466ece69e9d9bbb Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 2 Dec 2025 18:42:29 +0000 Subject: [PATCH 3/4] [skip roxygen] [skip vbump] Roxygen Man Pages Auto Update --- man/tm_a_gee.Rd | 16 ++++++++++++++++ man/tm_a_mmrm.Rd | 16 ++++++++++++++++ man/tm_g_barchart_simple.Rd | 16 ++++++++++++++++ man/tm_g_ci.Rd | 16 ++++++++++++++++ man/tm_g_forest_rsp.Rd | 16 ++++++++++++++++ man/tm_g_forest_tte.Rd | 16 ++++++++++++++++ man/tm_g_ipp.Rd | 16 ++++++++++++++++ man/tm_g_km.Rd | 16 ++++++++++++++++ man/tm_g_lineplot.Rd | 16 ++++++++++++++++ man/tm_g_pp_adverse_events.Rd | 16 ++++++++++++++++ man/tm_g_pp_patient_timeline.Rd | 16 ++++++++++++++++ man/tm_g_pp_vitals.Rd | 16 ++++++++++++++++ man/tm_t_abnormality.Rd | 16 ++++++++++++++++ man/tm_t_abnormality_by_worst_grade.Rd | 16 ++++++++++++++++ man/tm_t_ancova.Rd | 16 ++++++++++++++++ man/tm_t_binary_outcome.Rd | 16 ++++++++++++++++ man/tm_t_coxreg.Rd | 16 ++++++++++++++++ man/tm_t_events.Rd | 16 ++++++++++++++++ man/tm_t_events_by_grade.Rd | 16 ++++++++++++++++ man/tm_t_events_patyear.Rd | 16 ++++++++++++++++ man/tm_t_events_summary.Rd | 16 ++++++++++++++++ man/tm_t_exposure.Rd | 16 ++++++++++++++++ man/tm_t_glm_counts.Rd | 16 ++++++++++++++++ man/tm_t_logistic.Rd | 16 ++++++++++++++++ man/tm_t_mult_events.Rd | 16 ++++++++++++++++ man/tm_t_pp_basic_info.Rd | 16 ++++++++++++++++ man/tm_t_pp_laboratory.Rd | 16 ++++++++++++++++ man/tm_t_pp_medical_history.Rd | 16 ++++++++++++++++ man/tm_t_pp_prior_medication.Rd | 16 ++++++++++++++++ man/tm_t_shift_by_arm.Rd | 16 ++++++++++++++++ man/tm_t_shift_by_arm_by_worst.Rd | 16 ++++++++++++++++ man/tm_t_shift_by_grade.Rd | 16 ++++++++++++++++ man/tm_t_smq.Rd | 16 ++++++++++++++++ man/tm_t_summary.Rd | 16 ++++++++++++++++ man/tm_t_summary_by.Rd | 16 ++++++++++++++++ man/tm_t_tte.Rd | 16 ++++++++++++++++ 36 files changed, 576 insertions(+) diff --git a/man/tm_a_gee.Rd b/man/tm_a_gee.Rd index 67111f9d3..821246f7b 100644 --- a/man/tm_a_gee.Rd +++ b/man/tm_a_gee.Rd @@ -115,6 +115,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() diff --git a/man/tm_a_mmrm.Rd b/man/tm_a_mmrm.Rd index 7375d451f..c2daa1a5d 100644 --- a/man/tm_a_mmrm.Rd +++ b/man/tm_a_mmrm.Rd @@ -156,6 +156,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ arm_ref_comp <- list( diff --git a/man/tm_g_barchart_simple.Rd b/man/tm_g_barchart_simple.Rd index 93b31f7d9..dbc854bbb 100644 --- a/man/tm_g_barchart_simple.Rd +++ b/man/tm_g_barchart_simple.Rd @@ -97,6 +97,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_g_ci.Rd b/man/tm_g_ci.Rd index 1630ecaaa..fa5dabad7 100644 --- a/man/tm_g_ci.Rd +++ b/man/tm_g_ci.Rd @@ -96,6 +96,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_g_forest_rsp.Rd b/man/tm_g_forest_rsp.Rd index 4e3499bee..3c9c23ead 100644 --- a/man/tm_g_forest_rsp.Rd +++ b/man/tm_g_forest_rsp.Rd @@ -159,6 +159,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_g_forest_tte.Rd b/man/tm_g_forest_tte.Rd index 6d78c639a..21a61dc66 100644 --- a/man/tm_g_forest_tte.Rd +++ b/man/tm_g_forest_tte.Rd @@ -160,6 +160,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_g_ipp.Rd b/man/tm_g_ipp.Rd index c556bbe3a..07796e937 100644 --- a/man/tm_g_ipp.Rd +++ b/man/tm_g_ipp.Rd @@ -139,6 +139,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_g_km.Rd b/man/tm_g_km.Rd index 2b2785f46..21301df4e 100644 --- a/man/tm_g_km.Rd +++ b/man/tm_g_km.Rd @@ -158,6 +158,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_g_lineplot.Rd b/man/tm_g_lineplot.Rd index d7ea20e5f..191db2cf8 100644 --- a/man/tm_g_lineplot.Rd +++ b/man/tm_g_lineplot.Rd @@ -152,6 +152,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_g_pp_adverse_events.Rd b/man/tm_g_pp_adverse_events.Rd index 80b8570e3..21229eaac 100644 --- a/man/tm_g_pp_adverse_events.Rd +++ b/man/tm_g_pp_adverse_events.Rd @@ -118,6 +118,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_g_pp_patient_timeline.Rd b/man/tm_g_pp_patient_timeline.Rd index 945d79e18..bad38f69a 100644 --- a/man/tm_g_pp_patient_timeline.Rd +++ b/man/tm_g_pp_patient_timeline.Rd @@ -133,6 +133,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_g_pp_vitals.Rd b/man/tm_g_pp_vitals.Rd index 550daf442..d7caa95ac 100644 --- a/man/tm_g_pp_vitals.Rd +++ b/man/tm_g_pp_vitals.Rd @@ -109,6 +109,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(nestcolor) diff --git a/man/tm_t_abnormality.Rd b/man/tm_t_abnormality.Rd index 005fc6b66..e3c03aeaf 100644 --- a/man/tm_t_abnormality.Rd +++ b/man/tm_t_abnormality.Rd @@ -139,6 +139,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() diff --git a/man/tm_t_abnormality_by_worst_grade.Rd b/man/tm_t_abnormality_by_worst_grade.Rd index d738a9bca..93ae395ed 100644 --- a/man/tm_t_abnormality_by_worst_grade.Rd +++ b/man/tm_t_abnormality_by_worst_grade.Rd @@ -129,6 +129,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(dplyr) diff --git a/man/tm_t_ancova.Rd b/man/tm_t_ancova.Rd index 79ae187a6..212103f43 100644 --- a/man/tm_t_ancova.Rd +++ b/man/tm_t_ancova.Rd @@ -133,6 +133,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_binary_outcome.Rd b/man/tm_t_binary_outcome.Rd index ec3911b8d..142245d7f 100644 --- a/man/tm_t_binary_outcome.Rd +++ b/man/tm_t_binary_outcome.Rd @@ -167,6 +167,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() diff --git a/man/tm_t_coxreg.Rd b/man/tm_t_coxreg.Rd index a8aa8e30c..f6d1de002 100644 --- a/man/tm_t_coxreg.Rd +++ b/man/tm_t_coxreg.Rd @@ -152,6 +152,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ ## First example ## ============= diff --git a/man/tm_t_events.Rd b/man/tm_t_events.Rd index 43b5627b2..abb2f0e21 100644 --- a/man/tm_t_events.Rd +++ b/man/tm_t_events.Rd @@ -134,6 +134,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_events_by_grade.Rd b/man/tm_t_events_by_grade.Rd index bd9643fd1..b5246a9ca 100644 --- a/man/tm_t_events_by_grade.Rd +++ b/man/tm_t_events_by_grade.Rd @@ -126,6 +126,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_events_patyear.Rd b/man/tm_t_events_patyear.Rd index ab18d222c..e05b0d07f 100644 --- a/man/tm_t_events_patyear.Rd +++ b/man/tm_t_events_patyear.Rd @@ -126,6 +126,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(dplyr) diff --git a/man/tm_t_events_summary.Rd b/man/tm_t_events_summary.Rd index 776f18ff7..a371d0699 100644 --- a/man/tm_t_events_summary.Rd +++ b/man/tm_t_events_summary.Rd @@ -151,6 +151,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_exposure.Rd b/man/tm_t_exposure.Rd index 6fe95c30c..79f3f6d13 100644 --- a/man/tm_t_exposure.Rd +++ b/man/tm_t_exposure.Rd @@ -137,6 +137,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(dplyr) diff --git a/man/tm_t_glm_counts.Rd b/man/tm_t_glm_counts.Rd index 62ec68251..73fb6f1c7 100644 --- a/man/tm_t_glm_counts.Rd +++ b/man/tm_t_glm_counts.Rd @@ -121,6 +121,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- within(teal_data(), { ADSL <- tern::tern_ex_adsl diff --git a/man/tm_t_logistic.Rd b/man/tm_t_logistic.Rd index 22cc0a1fe..b37361e6a 100644 --- a/man/tm_t_logistic.Rd +++ b/man/tm_t_logistic.Rd @@ -110,6 +110,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(dplyr) diff --git a/man/tm_t_mult_events.Rd b/man/tm_t_mult_events.Rd index 20ed4e286..2e4c949a3 100644 --- a/man/tm_t_mult_events.Rd +++ b/man/tm_t_mult_events.Rd @@ -122,6 +122,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_pp_basic_info.Rd b/man/tm_t_pp_basic_info.Rd index df8fbff7d..13807270e 100644 --- a/man/tm_t_pp_basic_info.Rd +++ b/man/tm_t_pp_basic_info.Rd @@ -47,6 +47,22 @@ a \code{teal_module} object. \description{ This module produces a patient profile basic info report using ADaM datasets. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_pp_laboratory.Rd b/man/tm_t_pp_laboratory.Rd index 0ff7ae8a4..89adcaf86 100644 --- a/man/tm_t_pp_laboratory.Rd +++ b/man/tm_t_pp_laboratory.Rd @@ -77,6 +77,22 @@ a \code{teal_module} object. \description{ This module produces a patient profile laboratory table using ADaM datasets. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_pp_medical_history.Rd b/man/tm_t_pp_medical_history.Rd index ef30ec98b..cd88cefdb 100644 --- a/man/tm_t_pp_medical_history.Rd +++ b/man/tm_t_pp_medical_history.Rd @@ -85,6 +85,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_pp_prior_medication.Rd b/man/tm_t_pp_prior_medication.Rd index 961343d40..f92b8b48c 100644 --- a/man/tm_t_pp_prior_medication.Rd +++ b/man/tm_t_pp_prior_medication.Rd @@ -62,6 +62,22 @@ a \code{teal_module} object. \description{ This module produces a patient profile prior medication report using ADaM datasets. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ library(dplyr) data <- teal_data() diff --git a/man/tm_t_shift_by_arm.Rd b/man/tm_t_shift_by_arm.Rd index a6e8807a0..31be427c4 100644 --- a/man/tm_t_shift_by_arm.Rd +++ b/man/tm_t_shift_by_arm.Rd @@ -128,6 +128,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_shift_by_arm_by_worst.Rd b/man/tm_t_shift_by_arm_by_worst.Rd index af616c8fa..241138674 100644 --- a/man/tm_t_shift_by_arm_by_worst.Rd +++ b/man/tm_t_shift_by_arm_by_worst.Rd @@ -129,6 +129,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_shift_by_grade.Rd b/man/tm_t_shift_by_grade.Rd index 5e8375668..ac64de94d 100644 --- a/man/tm_t_shift_by_grade.Rd +++ b/man/tm_t_shift_by_grade.Rd @@ -143,6 +143,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_smq.Rd b/man/tm_t_smq.Rd index 02e0ee63a..e09db9c75 100644 --- a/man/tm_t_smq.Rd +++ b/man/tm_t_smq.Rd @@ -128,6 +128,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_summary.Rd b/man/tm_t_summary.Rd index 1c96b0008..0d0f95fcc 100644 --- a/man/tm_t_summary.Rd +++ b/man/tm_t_summary.Rd @@ -124,6 +124,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ # Preparation of the test case - use `EOSDY` and `DCSREAS` variables to demonstrate missing data. data <- teal_data() diff --git a/man/tm_t_summary_by.Rd b/man/tm_t_summary_by.Rd index 7339fcb6e..132ce7ab8 100644 --- a/man/tm_t_summary_by.Rd +++ b/man/tm_t_summary_by.Rd @@ -144,6 +144,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { diff --git a/man/tm_t_tte.Rd b/man/tm_t_tte.Rd index 83bf2e9b4..d417b006e 100644 --- a/man/tm_t_tte.Rd +++ b/man/tm_t_tte.Rd @@ -159,6 +159,22 @@ To learn more please refer to the vignette \code{vignette("transform-module-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } +\section{Reporting}{ + + + +This module returns an object of class \code{teal_module}, that contains a \code{server} function. +Since the server function returns a \code{teal_report} object, this makes this module reportable, which means that +the reporting functionality will be turned on automatically by the \code{teal} framework. + +For more information on reporting in \code{teal}, see the vignettes: +\itemize{ +\item \code{vignette("reportable-shiny-application", package = "teal.reporter")} +\item \code{vignette("adding-support-for-reporting-to-custom-modules", package = "teal")} +} + +} + \examples{ data <- teal_data() data <- within(data, { From f67df131e2cd6b2e1a2f6835149b8770a57e4414 Mon Sep 17 00:00:00 2001 From: Dony Unardi Date: Wed, 3 Dec 2025 04:23:30 -0800 Subject: [PATCH 4/4] update WORDLIST --- inst/WORDLIST | 1 + 1 file changed, 1 insertion(+) diff --git a/inst/WORDLIST b/inst/WORDLIST index 0c3e12504..acdbfa402 100644 --- a/inst/WORDLIST +++ b/inst/WORDLIST @@ -32,3 +32,4 @@ responder responders univariable unstratified +reportable