Creates a valid expression to generate a table to summarize variables by row groups.
template_summary_by(
parentname,
dataname,
arm_var,
id_var,
sum_vars,
by_vars,
var_labels = character(),
add_total = TRUE,
total_label = default_total_label(),
parallel_vars = FALSE,
row_groups = FALSE,
na.rm = FALSE,
na_level = default_na_str(),
numeric_stats = c("n", "mean_sd", "mean_ci", "median", "median_ci", "quantiles",
"range"),
denominator = c("N", "n", "omit"),
drop_arm_levels = TRUE,
drop_zero_levels = TRUE,
basic_table_args = teal.widgets::basic_table_args()
)a list of expressions to generate a table or plot object.
(character)
parent analysis data used in teal module, usually this refers to ADSL.
(character)
analysis data used in teal module.
(character)
variable names that can be used as arm_var.
(character)
the variable name for subject id.
(character)
names of the variables that should be summarized.
(character)
variable names used to split the summary by rows.
optional, (named character)
variable labels for relabeling the analysis variables.
(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").
(logical)
whether summarized variables should be arranged in columns. Can only be set to
TRUE if all chosen analysis variables are numeric.
(logical)
whether summarized variables should be arranged in row groups.
(logical)
whether NA values should be removed prior to analysis.
(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)
names of statistics to display for numeric summary variables. Available
statistics are n, mean_sd, mean_ci, median, median_ci, quantiles, range, and geom_mean.
(character)
chooses how percentages are calculated. With option N, the reference
population from the column total is used as the denominator. With option n, the number of non-missing
records in this row and column intersection is used as the denominator. If omit is chosen, then the
percentage is omitted.
(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.
(logical)
whether rows with zero counts in all columns should be removed from 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_summary_by()