Creates a valid expression to generate a table of events by term.
template_events(
dataname,
parentname,
arm_var,
hlt,
llt,
label_hlt = NULL,
label_llt = NULL,
add_total = TRUE,
total_label = default_total_label(),
na_level = default_na_str(),
event_type = "event",
sort_criteria = c("freq_desc", "alpha"),
sort_freq_col = total_label,
prune_freq = 0,
prune_diff = 0,
drop_arm_levels = TRUE,
incl_overall_sum = 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 the variable with high level term for events.
(character)
name of the variable with low level term for events.
(string)
label of the hlt variable from dataname. The label will be extracted from the
module.
(string)
label of the llt variable from dataname. The label will be extracted from the
module.
(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".
(character)
how to sort the final table. Default option freq_desc sorts
on column sort_freq_col by decreasing number of patients with event. Alternative option alpha sorts events
alphabetically.
(character)
column to sort by frequency on if sort_criteria is set to freq_desc.
(number)
threshold to use for trimming table using event incidence rate in any column.
(number)
threshold to use for trimming table using as criteria difference in
rates between any two columns.
(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.
(flag)
whether two rows which summarize the overall number of adverse events
should be included at the top of the table.
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_events()