diff --git a/.github/workflows/check.yaml b/.github/workflows/check.yaml index bf02a968f..ee2ebec25 100644 --- a/.github/workflows/check.yaml +++ b/.github/workflows/check.yaml @@ -41,6 +41,25 @@ jobs: checking top-level files .* NOTE unit-test-report-brand: >- https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/thumbs/teal.png + deps-installation-method: setup-r-dependencies + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm + insightsengineering/nestcolor + insightsengineering/roxy.shinylive r-cmd-non-cran: name: R CMD Check (non-CRAN) 🧬 uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main @@ -61,6 +80,25 @@ jobs: checking Rd .usage sections .* NOTE checking for unstated dependencies in vignettes .* NOTE checking top-level files .* NOTE + deps-installation-method: setup-r-dependencies + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm + insightsengineering/nestcolor + insightsengineering/roxy.shinylive coverage: name: Coverage πŸ“” uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main @@ -69,6 +107,25 @@ jobs: with: additional-env-vars: | NOT_CRAN=true + deps-installation-method: setup-r-dependencies + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm + insightsengineering/nestcolor + insightsengineering/roxy.shinylive linter: if: github.event_name != 'push' name: SuperLinter πŸ¦Έβ€β™€οΈ @@ -80,6 +137,25 @@ jobs: REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }} with: auto-update: true + deps-installation-method: setup-r-dependencies + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm + insightsengineering/nestcolor + insightsengineering/roxy.shinylive gitleaks: name: gitleaks πŸ’§ uses: insightsengineering/r.pkg.template/.github/workflows/gitleaks.yaml@main diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 57ae80042..784f18116 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -42,3 +42,22 @@ jobs: with: default-landing-page: latest-tag additional-unit-test-report-directories: unit-test-report-non-cran + deps-installation-method: setup-r-dependencies + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm + insightsengineering/nestcolor + insightsengineering/roxy.shinylive diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index aa3e7bb45..323ce2afd 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -16,12 +16,51 @@ jobs: REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }} with: default-landing-page: latest-tag + deps-installation-method: setup-r-dependencies + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm + insightsengineering/nestcolor + insightsengineering/roxy.shinylive validation: name: R Package Validation report πŸ“ƒ needs: release uses: insightsengineering/r.pkg.template/.github/workflows/validation.yaml@main secrets: REPO_GITHUB_TOKEN: ${{ secrets.REPO_GITHUB_TOKEN }} + with: + deps-installation-method: setup-r-dependencies + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm + insightsengineering/nestcolor + insightsengineering/roxy.shinylive release: name: Create release πŸŽ‰ uses: insightsengineering/r.pkg.template/.github/workflows/release.yaml@main @@ -46,6 +85,25 @@ jobs: checking top-level files .* NOTE unit-test-report-brand: >- https://raw.githubusercontent.com/insightsengineering/hex-stickers/main/thumbs/teal.png + deps-installation-method: setup-r-dependencies + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm + insightsengineering/nestcolor + insightsengineering/roxy.shinylive coverage: name: Coverage πŸ“” needs: [release, docs] @@ -55,6 +113,25 @@ jobs: with: additional-env-vars: | NOT_CRAN=true + deps-installation-method: setup-r-dependencies + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm + insightsengineering/nestcolor + insightsengineering/roxy.shinylive wasm: name: Build WASM packages πŸ§‘β€πŸ­ needs: release diff --git a/.github/workflows/scheduled.yaml b/.github/workflows/scheduled.yaml index fd71e5290..eb913b2ea 100644 --- a/.github/workflows/scheduled.yaml +++ b/.github/workflows/scheduled.yaml @@ -3,7 +3,7 @@ name: Scheduled πŸ•°οΈ on: schedule: - - cron: '45 3 * * 0' + - cron: "45 3 * * 0" workflow_dispatch: inputs: chosen-workflow: @@ -56,6 +56,23 @@ jobs: ) name: revdepcheck ↩️ uses: insightsengineering/r.pkg.template/.github/workflows/revdepcheck.yaml@main + with: + lookup-refs: | + insightsengineering/teal + insightsengineering/teal.transform + insightsengineering/tern + insightsengineering/rlistings + insightsengineering/formatters + insightsengineering/rtables + insightsengineering/rtables.officer + insightsengineering/teal.code + insightsengineering/teal.data + insightsengineering/teal.logger + insightsengineering/teal.reporter + insightsengineering/teal.widgets + insightsengineering/teal.slice + insightsengineering/tern.gee + insightsengineering/tern.mmrm rhub: if: > github.event_name == 'schedule' || ( @@ -70,12 +87,14 @@ jobs: insightsengineering/teal.transform insightsengineering/tern insightsengineering/rlistings + insightsengineering/formatters insightsengineering/rtables + insightsengineering/rtables.officer insightsengineering/teal.code insightsengineering/teal.data insightsengineering/teal.logger insightsengineering/teal.reporter - insightsengineering/teal.slice insightsengineering/teal.widgets + insightsengineering/teal.slice insightsengineering/tern.gee insightsengineering/tern.mmrm diff --git a/DESCRIPTION b/DESCRIPTION index d60e70082..5061956a7 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,7 +1,7 @@ Package: teal.modules.clinical Title: 'teal' Modules for Standard Clinical Outputs -Version: 0.9.1.9038 -Date: 2024-12-10 +Version: 0.9.1.9040 +Date: 2024-12-11 Authors@R: c( person("Joe", "Zhu", , "joe.zhu@roche.com", role = c("aut", "cre")), person("Jana", "Stoilova", , "jana.stoilova@roche.com", role = "aut"), diff --git a/NEWS.md b/NEWS.md index 91ce5b920..7c0402ea3 100644 --- a/NEWS.md +++ b/NEWS.md @@ -1,4 +1,4 @@ -# teal.modules.clinical 0.9.1.9038 +# teal.modules.clinical 0.9.1.9040 ### Enhancements * Added `teal.logger` functionality for logging changes in shiny inputs in all modules. diff --git a/R/tm_g_forest_rsp.R b/R/tm_g_forest_rsp.R index a7b59a28e..9cc32f7c6 100644 --- a/R/tm_g_forest_rsp.R +++ b/R/tm_g_forest_rsp.R @@ -14,7 +14,7 @@ #' * `pval`: p-value of the effect. #' Note, the statistics `n_tot`, `or`, and `ci` are required. #' @param riskdiff (`list`)\cr if a risk (proportion) difference column should be added, a list of settings to apply -#' within the column. See [control_riskdiff()] for details. If `NULL`, no risk difference column will be added. +#' within the column. See [tern::control_riskdiff()] for details. If `NULL`, no risk difference column will be added. #' @param obj_var_name (`character`)\cr additional text to append to the table title. #' @param responders (`character`)\cr values of `aval_var` that are considered to be responders. #' @param col_symbol_size (`integer` or `NULL`)\cr column index to be used to determine relative size for diff --git a/R/tm_t_coxreg.R b/R/tm_t_coxreg.R index ced01a41f..bde44f002 100644 --- a/R/tm_t_coxreg.R +++ b/R/tm_t_coxreg.R @@ -3,7 +3,7 @@ #' Creates a valid expression to generate a univariable Cox regression analysis. #' #' @inheritParams template_arguments -#' @param control (`list`)\cr list of settings for the analysis (see [control_coxreg()]). +#' @param control (`list`)\cr list of settings for the analysis (see [tern::control_coxreg()]). #' @param at (`list` of `numeric`)\cr when the candidate covariate is a `numeric` type variable, use `at` #' to specify the value of the covariate at which the effect should be estimated. #' @param append (`logical`)\cr whether the result should be appended to the previous one. diff --git a/R/tm_t_tte.R b/R/tm_t_tte.R index 84668c7ad..552689414 100644 --- a/R/tm_t_tte.R +++ b/R/tm_t_tte.R @@ -384,8 +384,8 @@ template_tte <- function(dataname = "ANL", #' pre-selected option for confidence level, each within range of (0, 1). #' @param conf_level_survfit ([teal.transform::choices_selected()])\cr object with all available choices and #' pre-selected option for confidence level, each within range of (0, 1). -#' @param event_desc_var (`character` or [data_extract_spec()])\cr variable name with the event description -#' information, optional. +#' @param event_desc_var (`character` or [teal.transform::data_extract_spec()])\cr variable name with the +#' event description information, optional. #' #' @section Decorating Module: #' @@ -396,8 +396,8 @@ template_tte <- function(dataname = "ANL", #' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. #' #' @details -#' * The core functionality of this module is based on [coxph_pairwise()], [surv_timepoint()], and [surv_time()] from -#' the `tern` package. +#' * The core functionality of this module is based on [tern::coxph_pairwise()], [tern::surv_timepoint()], +#' and [tern::surv_time()] from the `tern` package. #' * The arm and stratification variables are taken from the `parentname` data. #' * The following variables are used in the module: #' diff --git a/R/utils.R b/R/utils.R index d2af241ed..f3a4e916f 100644 --- a/R/utils.R +++ b/R/utils.R @@ -434,7 +434,7 @@ split_col_expr <- function(compare, combine, ref, arm_var) { #' #' @note uses the regex `\\*|:` to perform the split. #' -#' @return a [choices_selected()] object. +#' @return a [teal.transform::choices_selected()] object. #' #' @examples #' split_choices(choices_selected(choices = c("x:y", "a*b"), selected = all_choices())) diff --git a/man/split_choices.Rd b/man/split_choices.Rd index bea53ac31..13c4389bd 100644 --- a/man/split_choices.Rd +++ b/man/split_choices.Rd @@ -12,7 +12,7 @@ split_choices(x) object with interaction terms} } \value{ -a \code{\link[=choices_selected]{choices_selected()}} object. +a \code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}} object. } \description{ Split \code{choices_selected} objects with interactions into diff --git a/man/template_coxreg_m.Rd b/man/template_coxreg_m.Rd index d259da420..52e8cc999 100644 --- a/man/template_coxreg_m.Rd +++ b/man/template_coxreg_m.Rd @@ -45,7 +45,7 @@ to specify the value of the covariate at which the effect should be estimated.} \item{combine_comp_arms}{(\code{logical})\cr triggers the combination of comparison arms.} -\item{control}{(\code{list})\cr list of settings for the analysis (see \code{\link[=control_coxreg]{control_coxreg()}}).} +\item{control}{(\code{list})\cr list of settings for the analysis (see \code{\link[tern:control_coxreg]{tern::control_coxreg()}}).} \item{na_level}{(\code{string})\cr used to replace all \code{NA} or empty values in character or factor variables in the data. Defaults to \code{""}. To set a diff --git a/man/template_coxreg_u.Rd b/man/template_coxreg_u.Rd index b336dc303..8205d16d7 100644 --- a/man/template_coxreg_u.Rd +++ b/man/template_coxreg_u.Rd @@ -46,7 +46,7 @@ to specify the value of the covariate at which the effect should be estimated.} \item{combine_comp_arms}{(\code{logical})\cr triggers the combination of comparison arms.} -\item{control}{(\code{list})\cr list of settings for the analysis (see \code{\link[=control_coxreg]{control_coxreg()}}).} +\item{control}{(\code{list})\cr list of settings for the analysis (see \code{\link[tern:control_coxreg]{tern::control_coxreg()}}).} \item{na_level}{(\code{string})\cr used to replace all \code{NA} or empty values in character or factor variables in the data. Defaults to \code{""}. To set a diff --git a/man/template_forest_rsp.Rd b/man/template_forest_rsp.Rd index c0b824327..a367aef88 100644 --- a/man/template_forest_rsp.Rd +++ b/man/template_forest_rsp.Rd @@ -58,7 +58,7 @@ Note, the statistics \code{n_tot}, \code{or}, and \code{ci} are required. }} \item{riskdiff}{(\code{list})\cr if a risk (proportion) difference column should be added, a list of settings to apply -within the column. See \code{\link[=control_riskdiff]{control_riskdiff()}} for details. If \code{NULL}, no risk difference column will be added.} +within the column. See \code{\link[tern:control_riskdiff]{tern::control_riskdiff()}} for details. If \code{NULL}, no risk difference column will be added.} \item{conf_level}{(\code{numeric})\cr value for the confidence level within the range of (0, 1).} diff --git a/man/template_forest_tte.Rd b/man/template_forest_tte.Rd index 084845064..332f2f07c 100644 --- a/man/template_forest_tte.Rd +++ b/man/template_forest_tte.Rd @@ -61,7 +61,7 @@ are required. }} \item{riskdiff}{(\code{list})\cr if a risk (proportion) difference column should be added, a list of settings to apply -within the column. See \code{\link[=control_riskdiff]{control_riskdiff()}} for details. If \code{NULL}, no risk difference column will be added.} +within the column. See \code{\link[tern:control_riskdiff]{tern::control_riskdiff()}} for details. If \code{NULL}, no risk difference column will be added.} \item{conf_level}{(\code{numeric})\cr value for the confidence level within the range of (0, 1).} diff --git a/man/tm_g_forest_rsp.Rd b/man/tm_g_forest_rsp.Rd index 1472b09f3..3812c351a 100644 --- a/man/tm_g_forest_rsp.Rd +++ b/man/tm_g_forest_rsp.Rd @@ -75,7 +75,7 @@ Note, the statistics \code{n_tot}, \code{or}, and \code{ci} are required. }} \item{riskdiff}{(\code{list})\cr if a risk (proportion) difference column should be added, a list of settings to apply -within the column. See \code{\link[=control_riskdiff]{control_riskdiff()}} for details. If \code{NULL}, no risk difference column will be added.} +within the column. See \code{\link[tern:control_riskdiff]{tern::control_riskdiff()}} for details. If \code{NULL}, no risk difference column will be added.} \item{fixed_symbol_size}{(\code{logical})\cr When (\code{TRUE}), the same symbol size is used for plotting each estimate. Otherwise, the symbol size will be proportional to the sample size in each each subgroup.} diff --git a/man/tm_g_forest_tte.Rd b/man/tm_g_forest_tte.Rd index 30bf0ab2d..6a63e6fd9 100644 --- a/man/tm_g_forest_tte.Rd +++ b/man/tm_g_forest_tte.Rd @@ -83,7 +83,7 @@ are required. }} \item{riskdiff}{(\code{list})\cr if a risk (proportion) difference column should be added, a list of settings to apply -within the column. See \code{\link[=control_riskdiff]{control_riskdiff()}} for details. If \code{NULL}, no risk difference column will be added.} +within the column. See \code{\link[tern:control_riskdiff]{tern::control_riskdiff()}} for details. If \code{NULL}, no risk difference column will be added.} \item{conf_level}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and pre-selected option for the confidence level, each within range of (0, 1).} diff --git a/man/tm_t_tte.Rd b/man/tm_t_tte.Rd index 508c01531..3fb8d1828 100644 --- a/man/tm_t_tte.Rd +++ b/man/tm_t_tte.Rd @@ -76,8 +76,8 @@ for time points that can be used in \code{\link[tern:survival_timepoint]{tern::s \item{time_unit_var}{(\code{\link[teal.transform:choices_selected]{teal.transform::choices_selected()}})\cr object with all available choices and pre-selected option for the time unit variable.} -\item{event_desc_var}{(\code{character} or \code{\link[=data_extract_spec]{data_extract_spec()}})\cr variable name with the event description -information, optional.} +\item{event_desc_var}{(\code{character} or \code{\link[teal.transform:data_extract_spec]{teal.transform::data_extract_spec()}})\cr variable name with the +event description information, optional.} \item{add_total}{(\code{logical})\cr whether to include column with total number of patients.} @@ -118,8 +118,8 @@ template for \code{TTET01} available \href{https://insightsengineering.github.io } \details{ \itemize{ -\item The core functionality of this module is based on \code{\link[=coxph_pairwise]{coxph_pairwise()}}, \code{\link[=surv_timepoint]{surv_timepoint()}}, and \code{\link[=surv_time]{surv_time()}} from -the \code{tern} package. +\item The core functionality of this module is based on \code{\link[tern:survival_coxph_pairwise]{tern::coxph_pairwise()}}, \code{\link[tern:survival_timepoint]{tern::surv_timepoint()}}, +and \code{\link[tern:survival_time]{tern::surv_time()}} from the \code{tern} package. \item The arm and stratification variables are taken from the \code{parentname} data. \item The following variables are used in the module: \itemize{