cells_source_notes {gt} | R Documentation |
Location helper for targeting the source notes
Description
The cells_source_notes()
function is used to target all source notes in the
footer section of the table. This is useful for adding custom styles to the
source notes with tab_style()
(using the locations
argument). The
'source_notes' location is generated by the tab_source_note()
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).
Usage
cells_source_notes()
Value
A list object with the classes cells_source_notes
and
location_cells
.
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
Let's use a subset of the gtcars
dataset to create a gt table. Add a
source note (with tab_source_note()
) and style the source notes section
inside the tab_style()
call by using the cells_source_notes()
helper
function for the targeting via the locations
argument.
gtcars |> dplyr::select(mfr, model, msrp) |> dplyr::slice(1:5) |> gt() |> tab_source_note(source_note = "From edmunds.com") |> tab_style( style = cell_text( color = "#A9A9A9", size = "small" ), locations = cells_source_notes() )
Function ID
8-23
Function Introduced
v0.3.0
(May 12, 2021)
See Also
Other helper functions:
adjust_luminance()
,
cell_borders()
,
cell_fill()
,
cell_text()
,
cells_body()
,
cells_column_labels()
,
cells_column_spanners()
,
cells_footnotes()
,
cells_grand_summary()
,
cells_row_groups()
,
cells_stub_grand_summary()
,
cells_stub_summary()
,
cells_stubhead()
,
cells_stub()
,
cells_summary()
,
cells_title()
,
currency()
,
default_fonts()
,
define_units()
,
escape_latex()
,
from_column()
,
google_font()
,
gt_latex_dependencies()
,
html()
,
md()
,
nanoplot_options()
,
pct()
,
px()
,
random_id()
,
stub()
,
system_fonts()