tab_stubhead: Add label text to the stubhead

View source: R/tab_create_modify.R

tab_stubheadR Documentation

Add label text to the stubhead


Add a label to the stubhead of a gt table. The stubhead is the lone element that is positioned left of the column labels, and above the stub. If a stub does not exist, then there is no stubhead (so no change will be made when using this function in that case). We have the flexibility to use Markdown formatting for the stubhead label. Furthermore, if the table is intended for HTML output, we can use HTML for the stubhead label.


tab_stubhead(data, label)



A table object that is created using the gt() function.


The text to be used as the stubhead label We can optionally use the md() and html() functions to style the text as Markdown or to retain HTML elements in the text.


An object of class gt_tbl.


Function ID


See Also

Other Create or Modify Parts: tab_footnote(), tab_header(), tab_options(), tab_row_group(), tab_source_note(), tab_spanner_delim(), tab_spanner(), tab_style()


# Use `gtcars` to create a gt table; add
# a stubhead label to describe what is
# in the stub
tab_1 <-
  gtcars %>%
  dplyr::select(model, year, hp, trq) %>%
  dplyr::slice(1:5) %>%
  gt(rowname_col = "model") %>%
  tab_stubhead(label = "car")

gt documentation built on April 22, 2022, 1:05 a.m.