Modify table caption — modify_caption • ltsummary

The caption is shown as the title above the table. {N} in the text is replaced by the number of observations.

Usage

modify_caption(x, caption, text_interpret = c("md", "html", "none"))

Arguments

x: (ltsummary)
An ltsummary object.
caption: (string)
The caption text. {N} is replaced by the number of observations in the table.
text_interpret: (string)
How the text is interpreted: "md" (the default; the markdown subset **bold**, _italic_ and line breaks), "html" (raw HTML) or "none" (shown verbatim).

Value

An ltsummary object.

See also

Other modify and format: add_variable_group_header(), bold_italicize_labels_levels, bold_p(), modify_abbreviation(), modify_footnote_header(), modify_header(), modify_source_note(), remove_row_type(), separate_p_footnotes(), sort_p()

Examples

# Example 1 ----------------------------------
trial |>
  tbl_summary(by = trt, include = c(marker, stage)) |>
  modify_caption(caption = "**Baseline Characteristics** N = {N}")