Skip to contents

Bootstrap-branded ggplot with custom axis and legend

Source: R/ggplot.R
ggbrand.Rd

Shorthand to generate branded ggplots. Uses theme_brand() to control colors and fonts, and has Y-axis on the right. Axis placement can be quickly modified with argument axes.

Usage

ggbrand(
  data = NULL,
  mapping = aes(),
  axes = c("bottomright", "topright", "bottomleft", "topleft"),
  ...
)

Arguments

data

Default dataset to use for plot. If not already a data.frame, will be converted to one by fortify(). If not specified, must be supplied in each layer added to the plot.

mapping

Default list of aesthetic mappings to use for plot. If not specified, must be supplied in each layer added to the plot.

axes

position of X (bottom or top) and Y (left or right) primary axes (default: bottomright)

...

Arguments passed on to theme_brand

base_color

Bootstrap color name for text and line elements, or color code

base_bg

Bootstrap color name for plot, panel background, or color code

base_family

one of _brand.yml font families (currently only base, monospace, or headings), else a valid system or Google font family name

grid

show gridlines XY, X, Y (default) or n for no gridline

legend

shorthand for theme(legend.position="...") (default: top)

gradient

names of Bootstrap colors for continuous gradient (default: c("blue", "orange", "red"))

base_size

base font size, given in pts.

Value

A ggplot2 object with themef elements

Examples

require(ggplot2)

ggbrand(mtcars, aes(factor(carb), mpg, fill=factor(carb))) +
  geom_col() +
  labs(
    x = "carb",
    title = "Default Plot with Y-axis on the Right",
    subtitle = "My very long subtitle with many units",
    caption = "My very long plot caption with many references.")


# Equivalent to below
ggplot(mtcars, aes(factor(carb), mpg, fill=factor(carb))) +
  geom_col() +
  scale_brand_df() +
  guides(y=guide_axis(position="right")) +
  theme_brand(grid="XY")


ggbrand(mtcars, aes(wt, mpg, color=carb), axes="topright") +
  geom_smooth(color=pal("red"), fill=pal("pink")) +
  geom_point(size=3) +
  guides(color=guide_legend(nrow=1)) +
  labs(
    title = "My Beautiful Plot with X-axis at the Top",
    subtitle = "My descriptive subtitle with units",
    caption = "My plot caption with many references.")
#> `geom_smooth()` using method = 'loess' and formula = 'y ~ x'


ggbrand(mtcars, aes(wt, mpg, color=factor(cyl)),
  grid="XY", legend="bottom", base_family="Pacifico") +
  geom_point(size=3) +
  labs(
    x = "cyl",
    title = "My Plot with Full Gridlines and Pacifico Font",
    subtitle = "Placed the legend at the bottom",
    caption = "My plot caption with many references.")