add_overall_col {rtables}

Add overall column

Description

This function will only add an overall column at the top level of splitting, NOT within existing column splits. See add_overall_level() for the recommended way to add overall columns more generally within existing splits.

Usage

add_overall_col(lyt, label)

Arguments

lyt

(PreDataTableLayouts)
layout object pre-data used for tabulation.

label

(string)
a label (not to be confused with the name) for the object/structure.

Value

A PreDataTableLayouts object suitable for passing to further layouting functions, and to build_table().

See Also

add_overall_level()

Examples

lyt <- basic_table() %>%
  split_cols_by("ARM") %>%
  add_overall_col("All Patients") %>%
  analyze("AGE")
lyt

tbl <- build_table(lyt, DM)
tbl