R: Location helper for targeting the stub cells in a grand...

cells_stub_grand_summary {gt}

R Documentation

Location helper for targeting the stub cells in a grand summary

Description

cells_stub_grand_summary() is used to target the stub cells of a grand summary and it is useful when applying a footnote with tab_footnote() or adding custom styles with tab_style(). The function is expressly used in each of those functions' locations argument. The 'stub_grand_summary' location is generated by grand_summary_rows().

Usage

cells_stub_grand_summary(rows = everything())

Arguments

rows

Rows to target

⁠<row-targeting expression>⁠ // default: everything()

We can specify which rows should be targeted. The default everything() results in all rows in columns being formatted. Alternatively, we can supply a vector of row IDs within c(), a vector of row indices, or a select helper function (e.g. starts_with(), ends_with(), contains(), matches(), num_range() and everything()). We can also use expressions to filter down to the rows we need (e.g., ⁠[colname_1] > 100 & [colname_2] < 50⁠).

Value

A list object with the classes cells_stub_grand_summary and location_cells.

Targeting grand summary stub cells with `rows`

Targeting the stub cells of a grand summary row is done through the rows argument. Grand summary cells in the stub will have ID values that can be used much like column names in the columns-targeting scenario. We can use simpler tidyselect-style expressions (the select helpers should work well here) and we can use quoted row identifiers in c(). It's also possible to use row indices (e.g., c(3, 5, 6)) that correspond to the row number of a grand summary row.

Examples

Use a portion of the countrypops dataset to create a gt table. Add some styling to a grand summary stub cell with tab_style() and using cells_stub_grand_summary() in the locations argument.

countrypops |>
  dplyr::filter(country_name == "Spain", year < 1970) |>
  dplyr::select(-contains("country")) |>
  gt(rowname_col = "year") |>
  fmt_number(
    columns = population,
    decimals = 0
  ) |>
  grand_summary_rows(
    columns = population,
    fns = list(change = ~max(.) - min(.)),
    fmt = ~ fmt_integer(.)
  ) |>
  tab_style(
    style = cell_text(weight = "bold", transform = "uppercase"),
    locations = cells_stub_grand_summary(rows = "change")
  )

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

Function ID

8-22

Function Introduced

v0.3.0 (May 12, 2021)