gt (version 0.1.0)

cells_title: Location helper for targeting the table title and subtitle

Description

The cells_title() function is used to target the table title or subtitle 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.

Usage

cells_title(groups = c("title", "subtitle"))

Arguments

groups

We can either specify "title" or "subtitle" to target the title element or the subtitle element.

Value

A list object of classes cells_title and location_cells.

Figures

Function ID

7-5

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 the groups 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 the tab_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 the groups argument.

• cells_stub(): targets row labels in the table stub using the rows argument.

• cells_body(): targets data cells in the table body using intersections of columns and rows.

• cells_summary(): targets summary cells in the table body using the groups argument and intersections of columns and rows.

• cells_grand_summary(): targets cells of the table's grand summary using intersections of columns and rows

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_stub(), cells_summary(), currency(), escape_latex(), gt_latex_dependencies(), html(), md(), pct(), px(), random_id()

Examples

# NOT RUN {
# Use `sp500` to create a gt table; add
# a header with a title, and then add a
# footnote to the title with `tab_footnote()`
# and `cells_title()` (in `locations`)
tab_1 <-
  sp500 %>%
  dplyr::filter(
    date >= "2015-01-05" &
      date <="2015-01-10"
  ) %>%
  dplyr::select(
    -c(adj_close, volume, high, low)
  ) %>%
  gt() %>%
  tab_header(title = "S&P 500"
  ) %>%
  tab_footnote(
    footnote = "All values in USD.",
    locations = cells_title(groups = "title")
  )

# }