theme_blueprint: Flexible theme with sensible defaults for Blueprint-branded...

View source: R/theme_blueprint.R

theme_blueprintR Documentation

Flexible theme with sensible defaults for Blueprint-branded plots

Description

Flexible theme with sensible defaults for Blueprint-branded plots

Usage

theme_blueprint(
  base_family = "Arial",
  base_size = 11.5,
  plot_title_family = "GT Flexa",
  plot_title_size = 18,
  plot_title_face = "plain",
  plot_title_margin = 10,
  plot_title_position = "plot",
  plot_background_color = "#E6E6E6",
  subtitle_family = "Consolas",
  subtitle_size = 12,
  subtitle_margin = 15,
  subtitle_face = "plain",
  subtitle_color = "grey60",
  strip_text_family = base_family,
  strip_text_size = 12,
  strip_text_face = "plain",
  caption_family = base_family,
  caption_size = 9,
  caption_face = "italic",
  caption_margin = 10,
  axis_text_size = base_size,
  axis_title_family = base_family,
  axis_title_size = base_size,
  axis_title_face = "plain",
  axis_title_just = "rt",
  plot_margin = ggplot2::margin(5, 5, 5, 5),
  grid_col = "grey50",
  grid = TRUE,
  axis_col = "grey30",
  axis = TRUE,
  ticks = FALSE,
  legend_position = "b"
)

base_theme(base_family, base_size, plot_background_color)

style_labels(
  plot_title_family,
  plot_title_size,
  plot_title_face,
  plot_title_margin,
  plot_title_position,
  subtitle_family,
  subtitle_size,
  subtitle_face,
  subtitle_margin,
  subtitle_color,
  strip_text_family,
  strip_text_size,
  strip_text_face,
  caption_family,
  caption_size,
  caption_face,
  caption_margin,
  plot_margin,
  legend_position
)

style_axes(
  axis,
  axis_text_size,
  axis_title_family,
  axis_title_size,
  axis_title_face,
  axis_title_just,
  axis_col,
  ticks
)

style_grid(grid, grid_col)

theme_blueprint_2021(
  base_family = "Arial",
  base_size = 11.5,
  plot_title_family = "GT Flexa",
  plot_title_size = 18,
  plot_title_face = "plain",
  plot_title_margin = 10,
  plot_title_position = "plot",
  plot_background_color = "#E6E6E6",
  subtitle_family = "Consolas",
  subtitle_size = 12,
  subtitle_margin = 15,
  subtitle_face = "plain",
  subtitle_color = "grey60",
  strip_text_family = base_family,
  strip_text_size = 12,
  strip_text_face = "plain",
  caption_family = base_family,
  caption_size = 9,
  caption_face = "italic",
  caption_margin = 10,
  axis_text_size = base_size,
  axis_title_family = base_family,
  axis_title_size = base_size,
  axis_title_face = "plain",
  axis_title_just = "rt",
  plot_margin = ggplot2::margin(5, 5, 5, 5),
  grid_col = "grey50",
  grid = TRUE,
  axis_col = "grey30",
  axis = TRUE,
  ticks = FALSE,
  legend_position = "b"
)

Arguments

base_family

Character String indicating the default font family for text on the plot.

base_size

Number indicating the default point size for text on the plot.

plot_title_family

Character String indicating the font family for the plot's title.

plot_title_size

Number indicating the point size for the plot's title.

plot_title_face

Character String specifying the font face (e.g. "bold", "semibold") for the plot's title.

plot_title_margin

Number indicating the pixel size of the margin around the plot's title.

plot_title_position

Argument passed to ggplot::theme(plot.title.position)

plot_background_color

Character String indicating the background colour for the plot.

subtitle_family

Character String indicating the font family for the plot's subtitle.

subtitle_size

Number indicating the point size of the plot's subtitle.

subtitle_margin

Number indicating the pixel size of the margin around the plot's subtitle.

subtitle_face

Character String specifying the font face (e.g. "bold", "semibold") for the plot's subtitle.

subtitle_color

Character String specifying the color for the plot's subtitle.

strip_text_family

Character String indicating the font family for the plot's facet labels.

strip_text_size

Number indicating the point size for the plot's facet labels.

strip_text_face

Character String specifying the font face (e.g. "bold", "semibold") for the plot's facet labels.

caption_family

Character String indicating the font family for the plot's caption.

caption_size

Number indicating the point size for the plot's caption.

caption_face

Character String specifying the font face (e.g. "bold", "semibold") for the plot's caption.

caption_margin

Number indicating the pixel size of the margin around the plot's caption.

axis_text_size

Number indicating the point size for the plot's axis text.

axis_title_family

Character String indicating the font family for the plot's axis title(s).

axis_title_size

Number indicating the point size for the plot's axis title(s).

axis_title_face

Character String specifying the font face (e.g. "bold", "semibold") for the plot's title.

axis_title_just

Two-Character String indicating justification for the plots axis title(s). The first character controls x axis, while the second controls y. Each character can be one of the following:

  • "r" right justify the axis title

  • "l" left justify the axis title

  • "c" center justify the axis title

  • "t" top justify the axis title if it is vertically oriented

  • "b" bottom justify the axis title if it is vertically oriented

  • "m" middle justify the axis title if it is vertically oriented

plot_margin

Number indicating the margin in pixels around the plot's content

grid_col

Character String specifying the colour of the grid

grid

Character String (up to 4 characters from "XxYy") or Logical alias which toggles major and minor gridlines.

Behavior depends on which characters among "XxYy" are in the string:

  • "X" include major vertical gridlines

  • "x" include minor vertical gridlines

  • "Y" include major horizontal gridlines

  • "y" include minor horizontal gridlines

Logical aliases:

  • TRUE is "XxYy"

  • FALSE is ""

axis_col

Character String indicating the colour of the axis lines

axis

Character String (up to 2 from "xy") or Logical alias which toggles axis lines.

One of:

  • "xy" or TRUE draw both x and y axis lines

  • "x" draw x axis line but not y

  • "y" draw y axis line but not x

  • "" or FALSE don't draw axis lines

ticks

Logical if TRUE, draw ticks for each break in the x and y axes.

legend_position

Character String indicating the position of the legend. Passed directly to ggplot2::theme(legend.position)

One of:

  • "r" position the legend on the right

  • "b" position the legend on the bottom

Value

theme_blueprint returns a ggplot2 theme object


context-dependent/bptheme documentation built on May 4, 2023, 6:21 p.m.