The cells_stub() function is used to target the table's stub cells and it is useful when applying a footnote with tab_footnote() or adding a custom style with tab_style(). The function is expressly used in each of those functions' locations argument.

cells_stub(rows = TRUE)



The names of the rows that are to be targeted.


A list object with the classes cells_stub and location_cells.


When using any of the location helper functions with an appropriate function that has a locations argument, multiple locations can be targeted by enclosing several cells_*() helper functions in a list(). The following helper functions can be used to target cells (roughly in order from the top to the bottom of a table):

  • cells_title(): targets the table title or the table subtitle depending on the value given to the groups argument ("title" or "subtitle").

  • cells_stubhead(): targets the stubhead location, a cell of which is only available when there is a stub; a label in that location can be created by using the tab_stubhead() function.

  • cells_column_spanners(): targets the spanner column labels, which appear above the column labels.

  • cells_column_labels(): targets the column labels.

  • cells_row_groups(): targets the row group labels in any available row groups using the groups argument.

  • cells_stub(): targets row labels in the table stub using the rows argument.

  • cells_body(): targets data cells in the table body using intersections of columns and rows.

  • cells_summary(): targets summary cells in the table body using the groups argument and intersections of columns and rows.

  • cells_grand_summary(): targets cells of the table's grand summary using intersections of columns and rows


Function ID


See also


library(tidyr) # Use `sza` to create a gt table; color # all of the `month` values in the table # stub with `tab_style()`, using `cells_stub()` # in `locations` (`rows = TRUE` targets # all stub rows) tab_1 <- sza %>% dplyr::filter(latitude == 20 & tst <= "1000") %>% dplyr::select(-latitude) %>% dplyr::filter(! %>% tidyr::spread(key = "tst", value = sza) %>% gt(rowname_col = "month") %>% fmt_missing( columns = TRUE, missing_text = "" ) %>% tab_style( style = list( cell_fill(color = "darkblue"), cell_text(color = "white") ), locations = cells_stub(rows = TRUE) )