R/OECD_theme.R

In BBieri/WP6RTools: R Tools for WP6 Data Analysis Work

#' A ggplot2 theme for OECD style plots. Adapted from Hrbrmstr's ipsum theme.
#'
#' @importFrom ggplot2 theme margin element_text element_blank element_line element_rect
#' @param base_family,base_size base font family and size
#' @param main_col main color of the plot. Colors points, histogram bars, etc.
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margi
#' @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 justification, one of `[blmcrt]`
#' @param plot_margin plot margin (specify with `ggplot2::margin()`)
#' @param grid_col,axis_col grid & axis colors; both default to `#cccccc`
#' @param grid panel grid (`TRUE`, `FALSE`, or a combination of `X`, `x`, `Y`, `y`)
#' @param axis_text_size font size of axis text
#' @param axis add x or y axes? `TRUE`, `FALSE`, "`xy`"
#' @param ticks ticks if `TRUE` add ticks
#' @return Themes the current ggplot to current IHEID guidelines.
#' @examples
#' library(ggplot2)
#' library(dplyr)
#'
#' # seminal scatterplot
#'
#' ggplot(mtcars, aes(mpg, wt)) +
#'   geom_point() +
#'   labs(x="Fuel efficiency (mpg)", y="Weight (tons)",
#'        title="Seminal ggplot2 scatterplot example",
#'        subtitle="A plot that is only useful for demonstration purposes",
#'        caption="Brought to you by the letter 'g'") +
#'   theme_oecd()
#'
#' # seminal bar chart
#'
#' count(mpg, class) %>%
#'  ggplot(aes(class, n)) +
#'   geom_col(fill = oecd_palette("oecd", 7, type = "continuous")) +
#'   geom_text(aes(label=n), nudge_y=3) +
#'   labs(x="Vehicle Category", y="Number of Vehicles",
#'        title="Seminal ggplot2 bar chart example",
#'        subtitle="A plot that is only useful for demonstration purposes",
#'        caption="Source: somewhere on the web") +
#'   theme_oecd(grid="Y") +
#'   theme(axis.text.y=element_blank())
#' @export

theme_oecd <- function(base_family = "sans",
                        base_size = 11.5,
                        main_col = "grey35",
                        plot_title_family = base_family,
                        plot_title_size = 18,
                        plot_title_face = "bold",
                        plot_title_margin = 10,
                        subtitle_family = base_family,
                        subtitle_size = 12,
                        subtitle_face = "plain",
                        subtitle_margin = 15,
                        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 = subtitle_family,
                        axis_title_size = 9,
                        axis_title_face = "plain",
                        axis_title_just = "rt",
                        plot_margin = margin(30, 30, 30, 30),
                        grid_col = "grey85",
                        grid = TRUE,
                        axis_col = "grey35",
                        axis = FALSE,
                        ticks = FALSE)
{
  # Redefine some styles. Point colors, histogram colors etc...
  ggplot2::update_geom_defaults("point", list(colour = main_col))
  ggplot2::update_geom_defaults("line", list(colour = main_col))
  ggplot2::update_geom_defaults("area", list(colour = main_col,
                                             fill = main_col))
  ggplot2::update_geom_defaults("rect", list(colour = main_col,
                                             fill = main_col))
  ggplot2::update_geom_defaults("density", list(colour = main_col,
                                                fill = main_col))
  ggplot2::update_geom_defaults("bar", list(colour = main_col,
                                            fill = main_col))
  ggplot2::update_geom_defaults("col", list(colour = main_col,
                                            fill = main_col))
  ggplot2::update_geom_defaults("text", list(colour = "gray85"))
  # Apply minimal theme from ggplot
  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 (inherits(grid, "character") | grid == TRUE) {
    ret <- ret + theme(panel.grid = element_line(color = grid_col,
                                                 size = 0.2))
    ret <- ret + theme(panel.grid.major = element_line(color = grid_col,
                                                       size = 0.2))
    ret <- ret + theme(panel.grid.minor = element_line(color = grid_col,
                                                       size = 0.15))
    if (inherits(grid, "character")) {
      if (regexpr("X", grid)[1] < 0)
        ret <- ret + theme(panel.grid.major.x = element_blank())
      if (regexpr("Y", grid)[1] < 0)
        ret <- ret + theme(panel.grid.major.y = element_blank())
      if (regexpr("x", grid)[1] < 0)
        ret <- ret + theme(panel.grid.minor.x = element_blank())
      if (regexpr("y", grid)[1] < 0)
        ret <- ret + theme(panel.grid.minor.y = element_blank())
    }
  }
  else {
    ret <- ret + theme(panel.grid = element_blank())
  }
  if (inherits(axis, "character") | axis == TRUE) {
    ret <- ret + theme(axis.line = element_line(color = "#2b2b2b",
                                                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))
  ret <- ret + theme(axis.title.x = element_text(hjust = xj,
                                                 size = axis_title_size, family = axis_title_family,
                                                 face = axis_title_face))
  ret <- ret + theme(axis.title.y = element_text(hjust = yj,
                                                 size = axis_title_size, family = axis_title_family,
                                                 face = axis_title_face))
  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
}

#' A ggplot2 theme for OECD style plots. Adapted from Hrbrmstr's ipsum theme.
#'
#' @importFrom ggplot2 theme margin element_text element_blank element_line element_rect
#' @param base_family,base_size base font family and size
#' @param main_col main color of the plot. Colors points, histogram bars, etc.
#' @param plot_title_family,plot_title_face,plot_title_size,plot_title_margin plot title family, face, size and margi
#' @param subtitle_family,subtitle_face,subtitle_size,subtitle_col plot subtitle family, face, size, and color
#' @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 justification, one of `[blmcrt]`
#' @param plot_margin plot margin (specify with `ggplot2::margin()`)
#' @param grid panel grid (`TRUE`, `FALSE`, or a combination of `X`, `x`, `Y`, `y`)
#' @param axis_text_size font size of axis text
#' @param axis add x or y axes? `TRUE`, `FALSE`, "`xy`"
#' @param ticks ticks if `TRUE` add ticks
#' @return Themes the current ggplot to current IHEID guidelines.
#' @examples
#' library(ggplot2)
#' library(dplyr)
#'
#' # Seminal scatterplot
#'
#' ggplot(mtcars, aes(mpg, wt)) +
#'   geom_point() +
#'   labs(x="Fuel efficiency (mpg)", y="Weight (tons)",
#'        title="Seminal ggplot2 scatterplot example",
#'        subtitle="A plot that is only useful for demonstration purposes",
#'        caption="Brought to you by the letter 'g'") +
#'   theme_oecd_dark()
#'
#' # Seminal bar chart
#'
#' count(mpg, class) %>%
#'  ggplot(aes(class, n)) +
#'    geom_col(fill = oecd_palette("oecd", 21, type = "continuous")[15:21]) +
#'    geom_text(aes(label=n), nudge_y=3) +
#'    labs(x="Vehicle Category", y="Number of Vehicles",
#'         title="Seminal ggplot2 bar chart example",
#'         subtitle="A plot that is only useful for demonstration purposes",
#'         caption="Source: somewhere on the web") +
#'    theme_oecd(grid="Y") +
#'    theme(axis.text.y=element_blank())
#' @export

theme_oecd_dark <- function(base_family = "sans",
                             base_size = 11.5,
                             main_col = "#EBBB67",
                             plot_title_family = base_family,
                             plot_title_size = 18,
                             plot_title_face = "bold",
                             plot_title_margin = 10,
                             subtitle_family = "sans",
                             subtitle_size = 13,
                             subtitle_face = "plain",
                             subtitle_margin = 15,
                             subtitle_col = "gray85",
                             strip_text_family = base_family,
                             strip_text_size = 12,
                             strip_text_face = "plain",
                             caption_family = "sans",
                             caption_size = 9,
                             caption_face = "plain",
                             caption_margin = 10,
                             axis_text_size = base_size,
                             axis_title_family = base_family,
                             axis_title_size = 9,
                             axis_title_face = "plain",
                             axis_title_just = "rt",
                             plot_margin = margin(30, 30, 30, 30),
                             grid = TRUE,
                             axis = FALSE,
                             ticks = FALSE)
{
  grid_col <- axis_col <- "#464950"
  ggplot2::update_geom_defaults("point", list(colour = main_col))
  ggplot2::update_geom_defaults("line", list(colour = main_col))
  ggplot2::update_geom_defaults("area", list(colour = main_col,
                                             fill = main_col))
  ggplot2::update_geom_defaults("rect", list(colour = main_col,
                                             fill = main_col))
  ggplot2::update_geom_defaults("density", list(colour = main_col,
                                                fill = main_col))
  ggplot2::update_geom_defaults("bar", list(colour = main_col,
                                            fill = main_col))
  ggplot2::update_geom_defaults("col", list(colour = main_col,
                                            fill = main_col))
  ggplot2::update_geom_defaults("text", list(colour = "gray85"))
  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 (inherits(grid, "character") | grid == TRUE) {
    ret <- ret + theme(panel.grid = element_line(color = grid_col,
                                                 size = 0.2))
    ret <- ret + theme(panel.grid.major = element_line(color = grid_col,
                                                       size = 0.2))
    ret <- ret + theme(panel.grid.minor = element_line(color = grid_col,
                                                       size = 0.15))
    if (inherits(grid, "character")) {
      if (regexpr("X", grid)[1] < 0)
        ret <- ret + theme(panel.grid.major.x = element_blank())
      if (regexpr("Y", grid)[1] < 0)
        ret <- ret + theme(panel.grid.major.y = element_blank())
      if (regexpr("x", grid)[1] < 0)
        ret <- ret + theme(panel.grid.minor.x = element_blank())
      if (regexpr("y", grid)[1] < 0)
        ret <- ret + theme(panel.grid.minor.y = element_blank())
    }
  }
  else {
    ret <- ret + theme(panel.grid = element_blank())
  }
  if (inherits(axis, "character") | axis == TRUE) {
    ret <- ret + theme(axis.line = element_line(color = "white",
                                                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))
  ret <- ret + theme(axis.title.x = element_text(hjust = xj,
                                                 size = axis_title_size, family = axis_title_family,
                                                 face = axis_title_face))
  ret <- ret + theme(axis.title.y = element_text(hjust = yj,
                                                 size = axis_title_size, family = axis_title_family,
                                                 face = axis_title_face))
  ret <- ret + theme(strip.text = element_text(hjust = 0,
                                               size = strip_text_size, color = subtitle_col, 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, color = subtitle_col, 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)
  bkgrnd <- oecd_palettes[["oecd"]][["oecd_gray"]] # Background color
  fgrnd <- "#617a89" # Foreground color
  ret <- ret + theme(rect = element_rect(fill = bkgrnd, color = bkgrnd)) +
    theme(plot.background = element_rect(fill = bkgrnd,
                                         color = bkgrnd)) + theme(panel.background = element_rect(fill = bkgrnd,
                                                                                                  color = bkgrnd)) + theme(rect = element_rect(fill = bkgrnd,
                                                                                                                                               color = bkgrnd)) + theme(text = element_text(color = "#929299")) +
    theme(axis.text = element_text(color = "#929299")) +
    theme(title = element_text(color = "#929299")) + theme(plot.title = element_text(color = "white")) +
    theme(plot.subtitle = element_text(color = "#929299")) +
    theme(plot.caption = element_text(color = "#929299")) +
    theme(line = element_line(color = grid_col)) + theme(axis.ticks = element_line(color = grid_col))
}