cells_grand_summary | R Documentation |
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. The 'grand_summary' location
is generated by the grand_summary_rows()
function.
cells_grand_summary(columns = everything(), rows = everything())
columns |
The names of the columns that are to be targeted. |
rows |
The names of the rows that are to be targeted. |
A list object with the classes cells_grand_summary
and
location_cells
.
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())
).
columns
and rows
Targeting of grand summary cells is done through the columns
and rows
arguments. The columns
argument allows us to target a subset of grand
summary cells contained in the resolved columns. We say resolved because
aside from declaring column names in c()
(with bare column names or names
in quotes) we can use tidyselect-style expressions. This can be as basic
as supplying a select helper like starts_with()
, or, providing a more
complex incantation like
where(~ is.numeric(.x) && max(.x, na.rm = TRUE) > 1E6)
which targets numeric columns that have a maximum value greater than
1,000,000 (excluding any NA
s from consideration).
Once the columns are targeted, we may also target the rows
of the grand
summary. 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.
Use countrypops
to create a gt table. Add some styling to a grand
summary cell with with tab_style()
and cells_grand_summary()
.
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 = change ~ max(.) - min(.), fmt = ~ fmt_integer(.) ) |> tab_style( style = list( cell_text(style = "italic"), cell_fill(color = "lightblue") ), locations = cells_grand_summary( columns = population, rows = 1 ) )
8-14
v0.2.0.5
(March 31, 2020)
Other helper functions:
adjust_luminance()
,
cell_borders()
,
cell_fill()
,
cell_text()
,
cells_body()
,
cells_column_labels()
,
cells_column_spanners()
,
cells_footnotes()
,
cells_row_groups()
,
cells_source_notes()
,
cells_stub_grand_summary()
,
cells_stub_summary()
,
cells_stubhead()
,
cells_stub()
,
cells_summary()
,
cells_title()
,
currency()
,
default_fonts()
,
escape_latex()
,
google_font()
,
gt_latex_dependencies()
,
html()
,
md()
,
pct()
,
px()
,
random_id()
,
stub()
,
system_fonts()
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.