rm_stubhead: Remove the stubhead label

View source: R/tab_remove.R

rm_stubheadR Documentation

Remove the stubhead label


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.





The gt table data object

⁠obj:<gt_tbl>⁠ // required

This is the gt table object that is commonly created through use of the gt() function.


An object of class gt_tbl.


Using the gtcars datset, we'll create a gt table. With the tab_stubhead() function, 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")

This image of a table was generated from the first code example in the `rm_stubhead()` help file.

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)
This image of a table was generated from the second code example in the `rm_stubhead()` help file.

Function ID


Function Introduced

v0.8.0 (November 16, 2022)

See Also

Other part removal functions: rm_caption(), rm_footnotes(), rm_header(), rm_source_notes(), rm_spanners()

gt documentation built on June 22, 2024, 11:11 a.m.