teal.modules.clinical (version 0.10.0)

template_coxreg_m: Template: Multi-Variable Cox Regression

Description

Creates a valid expression to generate a multi-variable Cox regression analysis.

Usage

template_coxreg_m(
  dataname,
  cov_var,
  arm_var,
  cnsr_var,
  aval_var,
  ref_arm,
  comp_arm,
  paramcd,
  at = list(),
  strata_var = NULL,
  combine_comp_arms = FALSE,
  control = control_coxreg(),
  na_level = default_na_str(),
  basic_table_args = teal.widgets::basic_table_args()
)

Value

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

Arguments

dataname

(character)
analysis data used in teal module.

cov_var

(character)
names of the covariates variables.

arm_var

(character)
variable names that can be used as arm_var.

cnsr_var

(character)
name of the censoring variable.

aval_var

(character)
name of the analysis value variable.

ref_arm

(character)
the level of reference arm in case of arm comparison.

comp_arm

(character)
the level of comparison arm in case of arm comparison.

paramcd

(character)
name of the parameter code variable.

at

(list of numeric)
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.

strata_var

(character)
names of the variables for stratified analysis.

combine_comp_arms

(logical)
triggers the combination of comparison arms.

control

(list)
list of settings for the analysis (see tern::control_coxreg()).

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").

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").

See Also

template_coxreg_u(), tm_t_coxreg()