rm_caption: Remove the table caption
Description
We can easily remove the caption text from a gt table with
rm_caption(). The caption may exist if it were set through the gt()
caption argument or via tab_caption().
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 have a caption at all. This function is safe to use even if
there is no table caption set in the input gt_tbl object.
Usage
rm_caption(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, and, add a caption as well with tab_caption().
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")
) %>%
tab_caption(caption = md("**gt** table example."))gt_tbl
If you decide that you don't want the caption in the gt_tbl object,
it can be removed with the rm_caption() function.
rm_caption(data = gt_tbl)
Function ID
6-6
See Also
Other part removal functions:
rm_footnotes(),
rm_header(),
rm_source_notes(),
rm_spanners(),
rm_stubhead()