The cells_stubhead() function is used to target the table stubhead location when applying a footnote with tab_footnote() or adding custom style with tab_style(). The function is expressly used in each of those functions' locations argument.

cells_stubhead()

Value

A list object with the classes cells_stubhead and location_cells.

Details

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

Figures

Function ID

7-6

See also

Examples

# Use `pizzaplace` to create a gt table; # add a stubhead label and then style it # with `tab_style()` and `cells_stubhead()` tab_1 <- pizzaplace %>% dplyr::mutate(month = as.numeric(substr(date, 6, 7))) %>% dplyr::group_by(month, type) %>% dplyr::summarize(sold = dplyr::n()) %>% dplyr::ungroup() %>% dplyr::filter(month %in% 1:2) %>% gt(rowname_col = "type") %>% tab_stubhead(label = "type") %>% tab_style( style = cell_fill(color = "lightblue"), locations = cells_stubhead() )