R: Location helper for targeting the table stubhead cell

cells_stubhead {gt}

R Documentation

Location helper for targeting the table stubhead cell

Description

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. The 'stubhead' location is always present alongside the 'stub' location.

Usage

cells_stubhead()

Value

A list object with the classes cells_stubhead and location_cells.

Overview of location helper functions

Location helper functions can be used to target cells with virtually any function that has a locations argument. Here is a listing of all of the location helper functions, with locations corresponding roughly from top to 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 with the spanners argument; spanner column labels appear above the column labels.
cells_column_labels(): targets the column labels with its columns argument.
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
cells_stub_summary(): targets summary row labels in the table stub using the groups and rows arguments.
cells_stub_grand_summary(): targets grand summary row labels in the table stub using the rows argument.
cells_footnotes(): targets all footnotes in the table footer (cannot be used with tab_footnote()).
cells_source_notes(): targets all source notes in the table footer (cannot be used with tab_footnote()).

When using any of the location helper functions with an appropriate function that has a locations argument (e.g., tab_style()), multiple locations can be targeted by enclosing several ⁠cells_*()⁠ helper functions in a list() (e.g., list(cells_body(), cells_grand_summary())).

Examples

Using a summarized version of the pizzaplace dataset, let's create a gt table. Add a stubhead label with tab_stubhead() and then style it with tab_style() in conjunction with the use of cells_stubhead() in the locations argument.

pizzaplace |>
  dplyr::mutate(month = as.numeric(substr(date, 6, 7))) |>
  dplyr::group_by(month, type) |>
  dplyr::summarize(sold = dplyr::n(), .groups = "drop") |>
  dplyr::filter(month %in% 1:2) |>
  gt(rowname_col = "type") |>
  tab_stubhead(label = "type") |>
  tab_style(
    style = cell_fill(color = "lightblue"),
    locations = cells_stubhead()
  )

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

Function ID

8-12

Function Introduced

v0.2.0.5 (March 31, 2020)