modify_table_body: Modify Table Body

In gtsummary: Presentation-Ready Data Summary and Analytic Result Tables

Modify Table Body

Description

\lifecycle

maturing Function is for advanced manipulation of gtsummary tables. It allow users to modify the .$table_body data frame included in each gtsummary object.

If a new column is added to the table, default printing instructions will then be added to .$table_styling. By default, columns are hidden. To show a column, add a column header with modify_header().

Usage

modify_table_body(x, fun, ...)

Arguments

x	gtsummary object
fun	A function or formula. If a function, it is used as is. If a formula, e.g. fun = ~ .x %>% arrange(variable), it is converted to a function. The argument passed to fun= is x$table_body.
...	Additional arguments passed on to the mapped function

Example Output

Example 1

See Also

modify_table_styling()

See gtsummary internals vignette

Other Advanced modifiers: modify_column_alignment(), modify_column_hide(), modify_column_indent(), modify_column_merge(), modify_fmt_fun(), modify_table_styling()

Examples

# Example 1 --------------------------------
# Add number of cases and controls to regression table
modify_table_body_ex1 <-
  trial %>%
  select(response, age, marker) %>%
  tbl_uvregression(
    y = response,
    method = glm,
    method.args = list(family = binomial),
    exponentiate = TRUE,
    hide_n = TRUE
  ) %>%
  # adding number of non-events to table
  modify_table_body(
    ~ .x %>%
      dplyr::mutate(N_nonevent = N_obs - N_event) %>%
      dplyr::relocate(c(N_event, N_nonevent), .before = estimate)
  ) %>%
  # assigning header labels
  modify_header(N_nonevent = "**Control N**", N_event = "**Case N**") %>%
  modify_fmt_fun(c(N_event, N_nonevent) ~ style_number)

gtsummary documentation built on Jan. 13, 2023, 9:10 a.m.