R/theme_toronto.R

In UBC-MDS/hueniverrrsity: Make figures consistent with the visual identity of Canadian universities

#' The University of Toronto ggplot2 theme
#'
#' @param colour_use either 'fill' or 'colour' depending on the base plot.
#' @param colour_palette either 'vibrant', 'cool' or 'awards' depending on the use of the visualization.
#'
#' @description theme_toronto() creates a theme using the University of Toronto visual identity
#' to be used with ggplot2. See the visual identity at https://tinyurl.com/t3jjr49
#'
#' @return Reformatted ggplot with the University of Toronto's visual identity theme.
#' @export
#'
#' @examples
#'
#' \dontrun{
#' ggplot(data = mtcars, aes(x = hp, y = mpg, colour = as.factor(cyl))) +
#' geom_point(size = 2.5) +
#' theme_toronto('colour', 'vibrant')
#' }
#'
#' \dontrun{
#' ggplot(data = mtcars, aes(x = hp, fill = as.factor(cyl))) +
#' geom_density(alpha = 0.8) +
#' theme_toronto('fill', 'awards')
#' }
theme_toronto <- function(colour_use, colour_palette){

  new <- ggplot2::theme_bw() +
    ggplot2::theme(plot.title = ggplot2::element_text(size=14),
          axis.title.x = ggplot2::element_text(size=12),
          axis.text.x = ggplot2::element_text(size=11),
          axis.title.y = ggplot2::element_text(size=12),
          axis.text.y = ggplot2::element_text(size=11),
          legend.title = ggplot2::element_text(size=12),
          legend.text = ggplot2::element_text(size=11))

  ggplot2::theme_set(new)

  # Initialize colour palettes
  vibrant <- c('#002A5C', '#FFE498', '#008BB0', '#E31837')

  cool <- c('#002A5C', '#7BA4D9', '#008BB0', '#DAE5CD')

  awards <- c('#002A5C', '#FFE498', '#CECFCB', '#271100')

  if (colour_use %in% c('fill', 'colour')) {
    if (colour_palette == 'vibrant') {
      ggplot2::scale_discrete_manual(values = vibrant, aesthetics = colour_use)
    } else if (colour_palette == 'cool') {
      ggplot2::scale_discrete_manual(values = cool, aesthetics = colour_use)
    } else if (colour_palette == 'awards') {
      ggplot2::scale_discrete_manual(values = awards, aesthetics = colour_use)
    } else {
      stop("colour_palette should be one of 'vibrant', 'cool', or 'awards'")
    }
  } else
    stop("colour_use should be either 'fill' or 'colour'")
}