Creates a valid expression to generate a table of events by term.
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 .
|
hlt |
(character ) name of the variable with high level term for events.
|
llt |
(character ) name of the variable with low level term for events.
|
label_hlt |
(string ) label of the hlt variable from dataname . The label will be extracted from the
module.
|
label_llt |
(string ) label of the llt variable from dataname . The label will be extracted from the
module.
|
add_total |
(logical ) whether to include column 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") .
|
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") .
|
event_type |
(character ) type of event that is summarized (e.g. adverse event, treatment). Default
is "event" .
|
sort_criteria |
(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.
|
sort_freq_col |
(character ) column to sort by frequency on if sort_criteria is set to freq_desc .
|
prune_freq |
(number ) threshold to use for trimming table using event incidence rate in any column.
|
prune_diff |
(number ) threshold to use for trimming table using as criteria difference in
rates between any two columns.
|
drop_arm_levels |
(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.
|
incl_overall_sum |
(flag ) whether two rows which summarize the overall number of adverse events
should be included at the top of the table.
|
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") .
|