rm_stubhead: Remove the stubhead label
Description
We can easily remove the stubhead label from a gt table with
rm_stubhead(). The stubhead location only exists if there is a table stub
and the text in that cell is added through the tab_stubhead() function.
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 any content in the stubhead. This function is safe to
use even if there is no stubhead label in the input gt_tbl object.
Usage
rm_stubhead(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. With tab_stubhead(), it's possible
to add a stubhead label. This appears in the top-left and can be used to
describe what is in the stub.
gt_tbl <-
gtcars %>%
dplyr::select(model, year, hp, trq) %>%
dplyr::slice(1:5) %>%
gt(rowname_col = "model") %>%
tab_stubhead(label = "car")gt_tbl
If you decide that you don't want the stubhead label in the gt_tbl object,
it can be removed with the rm_stubhead() function.
rm_stubhead(data = gt_tbl)
Function ID
6-2
See Also
Other part removal functions:
rm_caption(),
rm_footnotes(),
rm_header(),
rm_source_notes(),
rm_spanners()