template_shift_by_arm: Template: Shift by Arm

In teal.modules.clinical: 'teal' Modules for Standard Clinical Outputs

Template: Shift by Arm

Description

Creates a valid expression to generate a summary table of analysis indicator levels by arm.

Usage

template_shift_by_arm(
  dataname,
  parentname,
  arm_var = "ARM",
  paramcd = "PARAMCD",
  visit_var = "AVISIT",
  treatment_flag_var = "ONTRTFL",
  treatment_flag = "Y",
  aval_var = "ANRIND",
  base_var = lifecycle::deprecated(),
  baseline_var = "BNRIND",
  na.rm = FALSE,
  na_level = default_na_str(),
  add_total = FALSE,
  total_label = default_total_label(),
  basic_table_args = teal.widgets::basic_table_args()
)

Arguments

dataname	(character) analysis data used in teal module.
parentname	(character) parent analysis data used in teal module, usually this refers to ADSL.
arm_var	(character) variable names that can be used as arm_var.
paramcd	(character) name of the parameter code variable.
visit_var	(character) variable names that can be used as visit variable. Must be a factor in dataname.
treatment_flag_var	(character) name of the on treatment flag variable.
treatment_flag	(character) name of the value indicating on treatment records in treatment_flag_var.
aval_var	(character) name of the analysis reference range indicator variable.
base_var	Please use the baseline_var argument instead.
baseline_var	(character) name of the baseline reference range indicator variable.
na.rm	(logical) whether NA values should be removed prior to analysis.
na_level	(string) used to replace all NA or empty values in character or factor variables in the data. Defaults to "<Missing>". To set a default na_level to apply in all modules, run set_default_na_str("new_default").
add_total	(logical) whether to include row with total number of patients.
total_label	(string) string to display as total column/row label if column/row is enabled (see add_total). Defaults to "All Patients". To set a new default total_label to apply in all modules, run set_default_total_label("new_default").
basic_table_args	(basic_table_args) optional object created by teal.widgets::basic_table_args() with settings for the module table. The argument is merged with option teal.basic_table_args and with default module arguments (hard coded in the module body). For more details, see the vignette: vignette("custom-basic-table-arguments", package = "teal.widgets").

Value

a list of expressions to generate a table or plot object.

See Also

tm_t_shift_by_arm()

teal.modules.clinical documentation built on April 4, 2025, 12:35 a.m.