brand.yml (version 0.1.0)

theme_brand_gt: Create a gt table theme using brand colors

Description

Apply brand colors to a gt table.

Usage

theme_brand_gt(table, brand = NULL, background = NULL, foreground = NULL)

Value

Returns a themed gt table object.

Arguments

table

A gt table object to theme.

brand

One of:

• NULL (default): Automatically detect and read a _brand.yml file

• A path to a brand.yml file or directory containing _brand.yml

• A brand object (as returned by read_brand_yml() or as_brand_yml())

• FALSE: Don't use a brand file; explicit colors must be provided

background

The background color, defaults to brand.color.background. If provided directly, this value can be a valid R color or the name of a color in brand.color or brand.color.palette.

foreground

The foreground color, defaults to brand.color.foreground. If provided directly, this value can be a valid R color or the name of a color in brand.color or brand.color.palette.

See Also

Other branded theming functions: theme_brand_flextable(), theme_brand_ggplot2(), theme_brand_plotly(), theme_brand_thematic()

Examples

if (FALSE) { # rlang::is_installed("gt") && getRversion() >= "4.5"
brand <- as_brand_yml('
color:
  palette:
    black: "#1A1A1A"
    white: "#F9F9F9"
    orange: "#FF6F20"
  foreground: black
  background: white
  primary: orange')

library(gt)
theme_brand_gt(
  gt(head(palmerpenguins::penguins)),
  brand
)
}
if (FALSE) { # rlang::is_installed("gt") && getRversion() < "4.5"
brand <- as_brand_yml('
color:
  palette:
    black: "#1A1A1A"
    white: "#F9F9F9"
    orange: "#FF6F20"
  foreground: black
  background: white
  primary: orange')

library(gt)
theme_brand_gt(
  gt(head(mtcars)),
  brand
)
}