Creates a valid expression to generate a table of multiple events by term.
template_mult_events(
dataname,
parentname,
arm_var,
seq_var,
hlt,
llt,
add_total = TRUE,
total_label = default_total_label(),
na_level = default_na_str(),
event_type = "event",
drop_arm_levels = TRUE,
basic_table_args = teal.widgets::basic_table_args()
)a list of expressions to generate a table or plot object.
(character)
analysis data used in teal module.
(character)
parent analysis data used in teal module, usually this refers to ADSL.
(character)
variable names that can be used as arm_var.
(character)
name of analysis sequence number variable. Used for counting the unique number
of events.
(character)
name of the variable with high level term for events.
(character)
name of the variable with low level term for events.
(logical)
whether to include column with total number of patients.
(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").
(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").
(character)
type of event that is summarized (e.g. adverse event, treatment). Default
is "event".
(logical)
whether to drop unused levels of arm_var. If TRUE, arm_var levels are
set to those used in the dataname dataset. If FALSE, arm_var levels are set to those used in the
parentname dataset. If dataname and parentname are the same, then drop_arm_levels is set to TRUE and
user input for this parameter is ignored.
optional, (basic_table_args)
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").
tm_t_mult_events()