cells_grand_summary: Location helper for targeting cells in a grand summary

Description Usage Arguments Details Value Figures Function ID See Also Examples

View source: R/helpers.R

Description

The cells_grand_summary() function is used to target the cells in 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.

Usage

1
cells_grand_summary(columns = TRUE, rows = TRUE)

Arguments

columns

The names of the columns that are to be targeted.

rows

The names of the rows that are to be targeted.

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_summary and location_cells.

Figures

Function ID

7-13

See Also

Other Helper Functions: adjust_luminance(), cell_borders(), cell_fill(), cell_text(), cells_body(), cells_column_labels(), cells_column_spanners(), cells_row_groups(), cells_stubhead(), 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
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Use `countrypops` to create a gt table; add
# some styling to a grand summary cell with
# with `tab_style()` and `cells_grand_summary()`
tab_1 <-
  countrypops %>%
  dplyr::filter(
    country_name == "Spain",
    year < 1970
  ) %>%
  dplyr::select(-contains("country")) %>%
  gt(rowname_col = "year") %>%
  fmt_number(
    columns = vars(population),
    decimals = 0
  ) %>%
  grand_summary_rows(
    columns = vars(population),
    fns = list(
      change = ~max(.) - min(.)
    ),
    formatter = fmt_number,
    decimals = 0
  ) %>%
  tab_style(
    style = list(
      cell_text(style = "italic"),
      cell_fill(color = "lightblue")
    ),
    locations = cells_grand_summary(
      columns = vars(population),
      rows = 1)
  )

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