cells_column_spanners {gt} | R Documentation |
Location helper for targeting the column spanners
Description
The cells_column_spanners()
function is used to target the cells that
contain the table column spanners. This is useful when applying a footnote
with tab_footnote()
or adding custom style with tab_style()
. The function
is expressly used in each of those functions' locations
argument. The
'column_spanners' location is generated by one or more uses of the
tab_spanner()
function or the tab_spanner_delim()
function.
Usage
cells_column_spanners(spanners = everything())
Arguments
spanners |
Specification of spanner IDs
The spanners to which targeting operations are constrained. Can either be a
series of spanner ID values provided in |
Value
A list object with the classes cells_column_spanners
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
Use the exibble
dataset to create a gt table. We'll add a spanner
column label over three columns (date
, time
, and datetime
) with
tab_spanner()
. The spanner column label can be styled with tab_style()
by
using the cells_column_spanners()
function in locations
. In this example,
we are making the text of the column spanner label appear as bold.
exibble |> dplyr::select(-fctr, -currency, -group) |> gt(rowname_col = "row") |> tab_spanner( label = "dates and times", columns = c(date, time, datetime), id = "dt" ) |> tab_style( style = cell_text(weight = "bold"), locations = cells_column_spanners(spanners = "dt") )
Function ID
8-13
Function Introduced
v0.2.0.5
(March 31, 2020)
See Also
Other helper functions:
adjust_luminance()
,
cell_borders()
,
cell_fill()
,
cell_text()
,
cells_body()
,
cells_column_labels()
,
cells_footnotes()
,
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()
,
define_units()
,
escape_latex()
,
from_column()
,
google_font()
,
gt_latex_dependencies()
,
html()
,
md()
,
nanoplot_options()
,
pct()
,
px()
,
random_id()
,
stub()
,
system_fonts()