rm_header: Remove the table header
Description
We can remove the table header from a gt table quite easily with
rm_header(). The table header is an optional table part (positioned above
the column labels) that can be added through the tab_header().
This function for removal is useful if you have received a gt table
(perhaps through an API that returns gt objects) but would prefer that
the table not contain a header. This function is safe to use even if there is
no header part in the input gt_tbl object.
Usage
rm_header(data)Value
An object of class gt_tbl.
Arguments
- data
A table object of class
gt_tbl.
Examples
Use gtcars to create a gt table. Add a header part with the
tab_header() function; with that, we get a title and a subtitle for the
table.
gt_tbl <-
gtcars %>%
dplyr::select(mfr, model, msrp) %>%
dplyr::slice(1:5) %>%
gt() %>%
tab_header(
title = md("Data listing from **gtcars**"),
subtitle = md("`gtcars` is an R dataset")
)gt_tbl
If you decide that you don't want the header in the gt_tbl object, it can
be removed with the rm_header() function.
rm_header(data = gt_tbl)
Function ID
6-1
See Also
Other part removal functions:
rm_caption(),
rm_footnotes(),
rm_source_notes(),
rm_spanners(),
rm_stubhead()