cells_stub
Location helper for targeting cells in the table stub
Description
The cells_stub() function is used to target the table's stub cells and it
is useful when applying a footnote with tab_footnote() or adding a custom
style with tab_style(). The function is expressly used in each of those
functions' locations argument.
Usage
cells_stub(rows = TRUE)
Arguments
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):
-
cells_title(): targets the table title or the table subtitle depending on the value given to thegroupsargument ("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, which appear above the column labels. -
cells_column_labels(): targets the column labels. -
cells_row_groups(): targets the row group labels in any available row groups using thegroupsargument. -
cells_stub(): targets row labels in the table stub using therowsargument. -
cells_body(): targets data cells in the table body using intersections ofcolumnsandrows. -
cells_summary(): targets summary cells in the table body using thegroupsargument and intersections ofcolumnsandrows. -
cells_grand_summary(): targets cells of the table's grand summary using intersections ofcolumnsandrows
Value
A list object with the classes cells_stub and location_cells.
Figures
Function ID
7-10
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_stubhead(),
cells_summary(),
cells_title(),
currency(),
default_fonts(),
escape_latex(),
google_font(),
gt_latex_dependencies(),
html(),
md(),
pct(),
px(),
random_id()
Examples
library(tidyr)
# Use `sza` to create a gt table; color
# all of the `month` values in the table
# stub with `tab_style()`, using `cells_stub()`
# in `locations` (`rows = TRUE` targets
# all stub rows)
tab_1 <-
sza %>%
dplyr::filter(latitude == 20 & tst <= "1000") %>%
dplyr::select(-latitude) %>%
dplyr::filter(!is.na(sza)) %>%
tidyr::spread(key = "tst", value = sza) %>%
gt(rowname_col = "month") %>%
fmt_missing(
columns = TRUE,
missing_text = ""
) %>%
tab_style(
style = list(
cell_fill(color = "darkblue"),
cell_text(color = "white")
),
locations = cells_stub(rows = TRUE)
)