rm_stubhead: Remove the stubhead label

In rstudio/gt: Easily Create Presentation-Ready Display Tables

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 with tab_stubhead().

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)

Arguments

data	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.

Value

An object of class gt_tbl.

Examples

Using the gtcars dataset, we'll 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 rm_stubhead().

rm_stubhead(data = gt_tbl)

Function ID

7-2

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()

rstudio/gt documentation built on Nov. 2, 2024, 5:53 p.m.