opt_stylize: Stylize your table with a colorful look

Description

With opt_stylize() you can quickly style your gt table with a carefully curated set of background colors, line colors, and line styles. There are six styles to choose from and they largely vary in the extent of coloring applied to different table locations. Some have table borders applied, some apply darker colors to the table stub and summary sections, and, some even have vertical lines. In addition to choosing a style preset, there are six color variations that each use a range of five color tints. Each of the color tints have been fine-tuned to maximize the contrast between text and its background. There are 36 combinations of style and color to choose from.

Usage

opt_stylize(data, style = 1, color = "blue", add_row_striping = TRUE)

Value

an object of class gt_tbl.

Arguments

data: A table object that is created using the gt() function.
style: Six numbered styles are available. Simply provide a number from 1 (the default) to 6 to choose a distinct look.
color: There are six color variations: "blue" (the default), "cyan", "pink", "green", "red", and "gray".
add_row_striping: An option to enable row striping in the table body for the style chosen. By default, this is TRUE.

Examples

Use exibble to create a gt table with a number of table parts added. Then, use the opt_stylize() function to give the table some additional style (using the "cyan" color variation and style number 6).

exibble %>%
  gt(rowname_col = "row", groupname_col = "group") %>%
  summary_rows(
    groups = "grp_a",
    columns = c(num, currency),
    fns = list(
      min = ~min(., na.rm = TRUE),
      max = ~max(., na.rm = TRUE)
    )) %>%
  grand_summary_rows(
    columns = currency,
    fns = list(
      total = ~sum(., na.rm = TRUE)
    )) %>%
  tab_source_note(source_note = "This is a source note.") %>%
  tab_footnote(
    footnote = "This is a footnote.",
    locations = cells_body(columns = 1, rows = 1)
  ) %>%
  tab_header(
    title = "The title of the table",
    subtitle = "The table's subtitle"
  ) %>%
  opt_stylize(style = 6, color = "cyan")

This image of a table was generated from the first code example in the `opt_stylize()` help file.

Function ID