R/theme_avenir.R

In brooke-watson/bplots: Minimal ggplot themes with Avenir fonts.

#' Minimal ggplot2 theme using Avenir fonts
#' Functionally an Avenir spin on (https://github.com/hrbrmstr/hrbrthemes/)
#'
#' @import ggplot2
#'
#' @param base_family,base_size base font family and size
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot tilte family, face, size and margin
#' @param subtitle_family,subtitle_face,subtitle_size plot subtitle family, face and size
#' @param subtitle_margin plot subtitle margin bottom (single numeric value)
#' @param strip_text_family,strip_text_face,strip_text_size facet label font family, face and size
#' @param caption_family,caption_face,caption_size,caption_margin plot caption family, face, size and margin
#' @param axis_title_family,axis_title_face,axis_title_size axis title font family, face and size
#' @param axis_title_just axis title font justificationk one of `[blmcrt]`
#' @param axis_text_size font size of axis text
#' @param plot_margin plot margin (specify with [ggplot2::margin])
#' @param grid_col grid color
#' @param grid panel grid (`TRUE`, `FALSE`, or a combination of `X`, `x`, `Y`, `y`)
#' @param axis_col axis color
#' @param axis add x or y axes? `TRUE`, `FALSE`, "`xy`"
#' @param ticks ticks if `TRUE` add ticks
#' @export
#'
#' @examples \dontrun{
#' library(ggplot2)
#'
#' ggplot(mtcars, aes(wt, mpg), col = displ) +
#'   geom_point() +
#'   theme_avenir() +
#'   labs(x = "omg this is very much the x axis",
#'     y = "yes definitely this indeed is the y axis",
#'     title = "Testing Testing: here's the thing",
#'     subtitle = "I am a subtitle so I am smaller",
#'     caption = label_wrap_gen(120)("wow when do you actually ever include captions in your ggplots??? just throw it in your Fig. 1 description and keep it moving. but fine, this is what it would look like if you insist.")
#'     )
#' }
theme_avenir <- function(
                         base_family = "Avenir", base_size = 10,
                         plot_title_family = base_family, plot_title_size = base_size * 1.4,
                         plot_title_margin = 5,
                         plot_title_face = "plain",
                         subtitle_family = "Avenir",
                         subtitle_size = base_size * 1.1,
                         subtitle_face = "plain", subtitle_margin = 5,
                         strip_text_family = base_family, strip_text_size = base_size,
                         strip_text_face = "plain",
                         caption_family = "Avenir",
                         caption_size = base_size * 0.8,
                         caption_face = "plain", caption_margin = 5,
                         caption = NULL,
                         axis_text_size = base_size,
                         axis_title_x = T,
                         axis_title_y = T,
                         axis_title_family = base_family,
                         axis_title_size = base_size * 0.8,
                         axis_title_face = "plain",
                         axis_title_just = "rt",
                         plot_margin = margin(5, 5, 5, 5),
                         grid_col = "#cccccc", grid = F, panel_x = F, panel_y = T,
                         axis_col = "#cccccc", axis = FALSE, ticks = FALSE) {
  ret <- ggplot2::theme_minimal(base_family = base_family, base_size = base_size)

  ret <- ret + theme(legend.background = element_blank())
  ret <- ret + theme(legend.key = element_blank())

  if (grid == F) {
    ret <- ret + theme(panel.grid = element_blank())
  }

  if (grid == T | panel_x == T) {
    ret <- ret + theme(panel.grid.major.x = element_line(color = grid_col, size = 0.2))
  }
  if (grid == T | panel_y == T) {
    ret <- ret + theme(panel.grid.major.y = element_line(color = grid_col, size = 0.2))
  } else {
    ret <- ret + theme(panel.grid = element_blank())
  }

  if (inherits(axis, "character") | axis == TRUE) {
    ret <- ret + theme(axis.line = element_line(color = axis_col, size = 0.15))
    if (inherits(axis, "character")) {
      axis <- tolower(axis)
      if (regexpr("x", axis)[1] < 0) {
        ret <- ret + theme(axis.line.x = element_blank())
      } else {
        ret <- ret + theme(axis.line.x = element_line(color = axis_col, size = 0.15))
      }
      if (regexpr("y", axis)[1] < 0) {
        ret <- ret + theme(axis.line.y = element_blank())
      } else {
        ret <- ret + theme(axis.line.y = element_line(color = axis_col, size = 0.15))
      }
    } else {
      ret <- ret + theme(axis.line.x = element_line(color = axis_col, size = 0.15))
      ret <- ret + theme(axis.line.y = element_line(color = axis_col, size = 0.15))
    }
  } else {
    ret <- ret + theme(axis.line = element_blank())
  }

  if (!ticks) {
    ret <- ret + theme(axis.ticks = element_blank())
    ret <- ret + theme(axis.ticks.x = element_blank())
    ret <- ret + theme(axis.ticks.y = element_blank())
  } else {
    ret <- ret + theme(axis.ticks = element_line(size = 0.15))
    ret <- ret + theme(axis.ticks.x = element_line(size = 0.15))
    ret <- ret + theme(axis.ticks.y = element_line(size = 0.15))
    ret <- ret + theme(axis.ticks.length = grid::unit(5, "pt"))
  }

  xj <- switch(tolower(substr(axis_title_just, 1, 1)), b = 0, l = 0, m = 0.5, c = 0.5, r = 1, t = 1)
  yj <- switch(tolower(substr(axis_title_just, 2, 2)), b = 0, l = 0, m = 0.5, c = 0.5, r = 1, t = 1)

  ret <- ret + theme(axis.text.x = element_text(size = axis_text_size, margin = margin(t = 0)))
  ret <- ret + theme(axis.text.y = element_text(size = axis_text_size, margin = margin(r = 0)))
  ret <- ret + theme(axis.title = element_text(size = axis_title_size, family = axis_title_family))
  if (axis_title_x) {
    ret <- ret + theme(axis.title.x = element_text(
      hjust = xj, size = axis_title_size,
      family = axis_title_family, face = axis_title_face
    ))
  } else {
    ret <- ret + theme(axis.title.x = element_blank())
  }
  if (axis_title_y) {
    ret <- ret + theme(axis.title.y = element_text(
      hjust = yj, size = axis_title_size,
      family = axis_title_family, face = axis_title_face
    ))
  } else {
    ret <- ret + theme(axis.title.y = element_blank())
  }
  ret <- ret + theme(axis.title.y.right = element_text(
    hjust = yj, size = axis_title_size, angle = 90,
    family = axis_title_family, face = axis_title_face
  ))
  ret <- ret + theme(strip.text = element_text(
    hjust = 0, size = strip_text_size,
    face = strip_text_face, family = strip_text_family
  ))
  ret <- ret + theme(panel.spacing = grid::unit(2, "lines"))
  ret <- ret + theme(plot.title = element_text(
    hjust = 0, size = plot_title_size,
    margin = margin(b = plot_title_margin),
    family = plot_title_family, face = plot_title_face
  ))
  ret <- ret + theme(plot.subtitle = element_text(
    hjust = 0, size = subtitle_size,
    margin = margin(b = subtitle_margin),
    family = subtitle_family, face = subtitle_face
  ))
  ret <- ret + theme(plot.caption = element_text(
    hjust = 1, size = caption_size,
    margin = margin(t = caption_margin),
    family = caption_family, face = caption_face
  ))
  ret <- ret + theme(plot.margin = plot_margin)

  ret
}