The cells_row_groups() function is used to target the table's row groups 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_row_groups(groups = TRUE)

Arguments

groups

The names of the row groups that are to be targeted.

Value

A list object with the classes cells_row_groups 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-9

See also

Examples

# Use `pizzaplace` to create a gt table # with grouped data; add a summary with the # `summary_rows()` function and then add a # footnote to the "peppr_salami" row group # label with `tab_footnote()` and with # `cells_row_groups()` in `locations` tab_1 <- pizzaplace %>% dplyr::filter( name %in% c("soppressata", "peppr_salami") ) %>% dplyr::group_by(name, size) %>% dplyr::summarize( `Pizzas Sold` = dplyr::n() ) %>% gt(rowname_col = "size") %>% summary_rows( groups = TRUE, columns = vars("Pizzas Sold"), fns = list(TOTAL = "sum"), formatter = fmt_number, decimals = 0, use_seps = TRUE ) %>% tab_footnote( footnote = "The Pepper-Salami.", cells_row_groups(groups = "peppr_salami") )