modify_source_note: Modify source note

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

Modify source note

Description

Add and remove source notes from a table. Source notes are similar to footnotes, expect they are not linked to a cell in the table.

Usage

modify_source_note(x, source_note, text_interpret = c("md", "html"))

remove_source_note(x, source_note_id)

Arguments

x	(gtsummary) A gtsummary object.
source_note	(string) A string to add as a source note.
text_interpret	(string) String indicates whether text will be interpreted with gt::md() or gt::html(). Must be "md" (default) or "html". Applies to tables printed with {gt}.
source_note_id	(integers) Integers specifying the ID of the source note to remove. Source notes are indexed sequentially at the time of creation.

Details

Source notes are not supported by as_kable_extra().

Value

gtsummary object

Examples

# Example 1 ----------------------------------
tbl <- tbl_summary(trial, include = c(marker, grade), missing = "no") |>
  modify_source_note("Results as of June 26, 2015")

# Example 2 ----------------------------------
remove_source_note(tbl, source_note_id = 1)

gtsummary documentation built on April 3, 2025, 10:18 p.m.