The cells_footnotes()
function is used to target all footnotes in the
footer section of the table. This is useful for adding custom styles to the
footnotes with tab_style()
(using the locations
argument). The
'footnotes' location is generated by one or more uses of the tab_footnote()
function. This location helper function cannot be used for the locations
argument of tab_footnote()
and doing so will result in a warning (with no
change made to the table).
Overview of location helper functions
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 thegroups
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 thetab_stubhead()
function.cells_column_spanners()
: targets the spanner column labels with thespanners
argument; spanner column labels appear above the column labels.cells_column_labels()
: targets the column labels with itscolumns
argument.cells_row_groups()
: targets the row group labels in any available row groups using thegroups
argument.cells_stub()
: targets row labels in the table stub using therows
argument.cells_body()
: targets data cells in the table body using intersections ofcolumns
androws
.cells_summary()
: targets summary cells in the table body using thegroups
argument and intersections ofcolumns
androws
.cells_grand_summary()
: targets cells of the table's grand summary using intersections ofcolumns
androws
cells_stub_summary()
: targets summary row labels in the table stub using thegroups
androws
arguments.cells_stub_grand_summary()
: targets grand summary row labels in the table stub using therows
argument.cells_footnotes()
: targets all footnotes in the table footer (cannot be used withtab_footnote()
).cells_source_notes()
: targets all source notes in the table footer (cannot be used withtab_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())
).
Examples
Using a subset of the sza
dataset, let's create a gt table. We'd like
to color the sza
column so that's done with the data_color()
function. We
can add a footnote through the tab_footnote()
function and we can also
style the footnotes section. The styling is done through the use of the
tab_style()
function and to target the footnotes we use locations = cells_footnotes()
.
sza |>
dplyr::filter(
latitude == 20 &
month == "jan" &
!is.na(sza)
) |>
dplyr::select(-latitude, -month) |>
gt() |>
data_color(
columns = sza,
palette = c("white", "yellow", "navyblue"),
domain = c(0, 90)
) |>
tab_footnote(
footnote = "Color indicates height of sun.",
locations = cells_column_labels(columns = sza)
) |>
tab_options(table.width = px(320)) |>
tab_style(
style = list(
cell_text(size = "smaller"),
cell_fill(color = "gray90")
),
locations = cells_footnotes()
)
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_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()