cells_stubhead: Location helper for targeting the table stubhead cell

Description Usage Details Value Figures Function ID See Also Examples

View source: R/helpers.R

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.

Usage

1

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

Value

A list object with the classes cells_stubhead and location_cells.

Figures

Function ID

7-6

See Also

Other Helper Functions: adjust_luminance(), cell_borders(), cell_fill(), cell_text(), cells_body(), cells_column_labels(), cells_column_spanners(), cells_grand_summary(), cells_row_groups(), cells_stub(), cells_summary(), cells_title(), currency(), default_fonts(), escape_latex(), google_font(), gt_latex_dependencies(), html(), md(), pct(), px(), random_id()

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# 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()
  )

gt documentation built on Aug. 6, 2020, 1:07 a.m.