Skip to contents

Apply Bootstrap brand to base, lattice and ggplot2 graphics

Source: R/theme.R
brand_on.Rd

Applies Bootstrap branding to R graphics using thematic R package utilities. This function behaves like thematic::thematic_on() but instead of passing individual colors and fonts, the user can provide an external _brand.yml configuration file. brand_on takes color and font variable names per Boostrap branding (hence, do not provide hex color codes, edit _brand.yml instead).

Usage

brand_on(
  file = NULL,
  bg = "background",
  fg = "foreground",
  accent = c("primary", "secondary"),
  font = "monospace-inline",
  sequential = NULL,
  qualitative = NULL,
  gradient = c("orange", "light", "green"),
  n = 20,
  alpha = 0.9,
  ...
)

Arguments

file

path to _brand.yml brand configuration file, normally this file is auto-detected in the working tree, but may be specified here to swap branding dynamically

bg

a background color.

fg

a foreground color.

accent

a color for making certain graphical markers 'stand out' (e.g., the fitted line color for ggplot2::geom_smooth()). Can be 2 colors for lattice (stroke vs fill accent).

font

a font_spec() object. If missing, font defaults are not altered.

sequential

a color palette for graphical markers that encode numeric values. Can be a vector of color codes or a sequential_gradient() object.

qualitative

a color palette for graphical markers that encode qualitative values (won't be used in ggplot2 when the number of data levels exceeds the max allowed colors). Defaults to okabe_ito().

gradient

Vector of Bootstrap color (names) to use in plot gradients

n

Number of colors to interpolate in plot gradients (default: 20)

alpha

Transparency for color scales between 0 and 1 (default: .9)

Value

a theme object as a list

Details

Typically charts will use Boostrap sans-serif font, but as of compiling that variable is not readily available in brand.yml schema, so brand_on will take the first font in the typography tree.

Examples

#brand_on()

# base
hist(rchisq(100, df=4), freq=FALSE, ylim=c(0, 0.2),
col=1:11, border="white", xlab=NA)
grid(NA, NULL, col="white")
curve(dchisq(x, df=4), col=3, lty=2, lwd=2, add=TRUE)


# lattice
lattice::show.settings()


# ggplot2
require(ggplot2)
#> Loading required package: ggplot2
ggplot(mtcars, aes(factor(carb), mpg, fill=carb)) +
  geom_col() +
  labs(
    x = "carb", y = NULL,
    title = "Default Plot with Bootstrap Branding",
    subtitle = "My very long subtitle with many units",
    caption = "My very long plot caption with many references.")


#brand_on(
#  fg="white", bg="purple", font="Oswald",
#  gradient=c("teal", "light", "dark"), alpha=1)

ggplot(mtcars, aes(factor(carb), mpg, fill=carb)) +
  geom_col()


ggplot(mtcars, aes(factor(carb), mpg, fill=carb)) +
  geom_col() +
  guides(y=guide_axis(position="right")) +
  theme_brand(base_bg="light")