location-helper {gt} | R Documentation |
Helper to target cells at locations
Description
This listing 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 usingtab_stubhead()
. -
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()
).
*
are the only functions usable by the text_*()
functions.
Note
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())
).
See Also
Functions with locations
argument:
These functions contain more example of usage.
Other location helper functions:
cells_body()
,
cells_column_labels()
,
cells_column_spanners()
,
cells_footnotes()
,
cells_grand_summary()
,
cells_row_groups()
,
cells_source_notes()
,
cells_stub()
,
cells_stub_grand_summary()
,
cells_stub_summary()
,
cells_stubhead()
,
cells_summary()
,
cells_title()