R/ussc_colours.R

In USStudiesCentre/ussc: Functions and Scripts Used at the United States Studies Centre

## Functions to create USSC colour palettes for ggplot2
## Zoe Meers
## The United States Studies Centre at the University of Sydney

#' USSC colours
ussc_cols <- c(
  `light blue` = "#4aace9",
  `dark blue` = "#2f2665",
  `orange` = "#ee4627",
  `pink` = "#e1a6a0",
  `grey` = "#c0c0c0",
  `green` = "#94c497",
  `red` = "#ed1b35",
  `white` = "#FFFFFF",
  `black` = "#000000",
  `Republican` = "#ed1b35",
  `Democrat` = "#009de3",
  `Independent` = "#c8c8c8",
  `Labor` = "#ed1b35",
  `Coalition` = "#009de3",
  `Greens` = "darkgreen",
  `Other/NV` = "#C0C0C0",
  `All` = "#696969",
  `Trump` = "#ed1b35",
  `Clinton` = "#009de3"
)

#' Function to extract USSC colours as hex codes
#'
#' @param ... Character names of ussc_colours
#' @examples
#' ussc::ussc_colours(c("light blue", "orange"))
#' @author
#' Zoe Meers
#' @export
ussc_colours <- function(...) {
  cols <- c(...)

  if (is.null(cols)) {
    return(ussc_cols)
  }

  ussc_cols[cols]
}

#' Function to extract USSC colours as hex codes
#'
#' @param ... Character names of ussc_colors
#' @examples
#' ussc::ussc_colors("light blue")
#' @author
#' Zoe Meers
#' @export

ussc_colors <- function(...) {
  cols <- c(...)
  
  if (is.null(cols)) {
    return(ussc_cols)
  }
  
  ussc_cols[cols]
}

#' USSC palettes
#' @description
#' This function prints the `ussc` colors as organised by political party or dark or light color scheme.
#' @examples 
#' ussc::ussc_palettes_list
#' @author
#' Zoe Meers
#' @export

ussc_palettes_list <- list(
  `main` = ussc_colours("dark blue", "light blue", "orange"),

  `blue` = ussc_colours("light blue", "dark blue"),
  
  `light_blue_to_orange` = ussc_colours("light blue", "orange"),
  
  `dark_blue_to_orange` =  ussc_colours("dark blue", "orange"),

  `light` = ussc_colours("light blue", "orange", "pink", "grey"),

  `mixed` = ussc_colours("dark blue", "light blue", "orange", "pink", "grey", "green"),
  
  `uspol` = ussc_colours("Democrat", "Independent",  "Republican"),
  
  `auspol` = ussc_colours("Coalition", "Greens", "Labor"),
  
  `ussc_survey_uspol` = ussc_colours("All", "Clinton",  "Other/NV", "Trump"),
  
  `ussc_survey_auspol`= ussc_colours("All", "Coalition", "Greens", "Labor", "Other/NV"),
  
  `ussc_survey_pol` = ussc_colours("All", "Clinton", "Coalition", "Greens", "Labor", "Other/NV", "Trump")
)

#' Return function to interpolate a ussc colour palette
#'
#' @param palette Character name of palette in ussc_palettes (i.e. main, blue, light, dark, grey, mixed)
#' @param reverse Boolean indicating whether the palette should be reversed
#' @param ... Additional arguments to pass to colorRampPalette()
#' @author
#' Zoe Meers

ussc_palettes <- function(palette = "main", reverse = FALSE, ...) {
  pal <- ussc_palettes_list[[palette]]

  if (reverse) pal <- rev(pal)

  grDevices::colorRampPalette(pal, ...)
}

#' Colour scale constructor for USSC colours
#'
#' @param palette Character name of palette in ussc_palettes_list (i.e. main, blue, light, dark, grey, mixed)
#' @param discrete Boolean indicating whether colour aesthetic is discrete or not
#' @param reverse Boolean indicating whether the palette should be reversed
#' @param ... Additional arguments passed to discrete_scale() or
#'            scale_colour_gradientn(), used respectively when discrete is TRUE or FALSE
#' @examples
#' # Colour by discrete variable using default palette
#' ggplot2::ggplot(iris, ggplot2::aes(Sepal.Width, Sepal.Length, colour = Species)) + ggplot2::geom_point(size = 4) + ussc::scale_colour_ussc()
#' # Reverse colour using blue palette
#' ggplot2::ggplot(iris, ggplot2::aes(Sepal.Width, Sepal.Length, colour = Species)) + ggplot2::geom_point(size = 4) + ussc::scale_colour_ussc('blue', reverse=T)
#' # Remember, you can change the transparency of the colour by adding alpha to the geom_...() call
#' ggplot2::ggplot(iris, ggplot2::aes(Sepal.Width, Sepal.Length, colour = Species)) + ggplot2::geom_point(size = 4, alpha=0.4) + ussc::scale_colour_ussc('blue', reverse=T)
#' @author
#' Zoe Meers
#' @export

scale_colour_ussc <- function(palette = "main", discrete = TRUE, reverse = FALSE, ...) {
  pal <- ussc_palettes(palette = palette, reverse = reverse)

  if (discrete) {
    ggplot2::discrete_scale("colour", paste0("ussc_", palette), palette = pal, ...)
  } else {
    ggplot2::scale_colour_gradientn(colours = pal(256), ...)
  }
}

#' Colour scale constructor for USSC colours
#'
#' @param palette Character name of palette in ussc_pal (i.e. main, blue, light, dark, grey, mixed)
#' @param discrete Boolean indicating whether colour aesthetic is discrete or not
#' @param reverse Boolean indicating whether the palette should be reversed
#' @param ... Additional arguments passed to discrete_scale() or
#'            scale_colour_gradientn(), used respectively when discrete is TRUE or FALSE
#' @examples
#' # Colour by discrete variable using default palette
#' ggplot2::ggplot(iris, ggplot2::aes(Sepal.Width, Sepal.Length, colour = Species)) + ggplot2::geom_point(size = 4) + ussc::scale_colour_ussc()
#' # Reverse colour using blue palette
#' ggplot2::ggplot(iris, ggplot2::aes(Sepal.Width, Sepal.Length, colour = Species)) + ggplot2::geom_point(size = 4) + ussc::scale_colour_ussc('blue', reverse=T)
#' # Remember, you can change the transparency of the colour by adding alpha to the geom_...() call
#' ggplot2::ggplot(iris, ggplot2::aes(Sepal.Width, Sepal.Length, colour = Species)) + ggplot2::geom_point(size = 4, alpha=0.4) + ussc::scale_colour_ussc('blue', reverse=T)
#' @author
#' Zoe Meers
#' @export

scale_color_ussc <- function(palette = "main", discrete = TRUE, reverse = FALSE, ...) {
  pal <- ussc_palettes(palette = palette, reverse = reverse)
  
  if (discrete) {
    ggplot2::discrete_scale("colour", paste0("ussc_", palette), palette = pal, ...)
  } else {
    ggplot2::scale_colour_gradientn(colours = pal(256), ...)
  }
}

#' Fill scale constructor for USSC colours
#'
#' @param palette Character name of palette in ussc_pal (i.e. main, blue, light, dark, grey, mixed)
#' @param discrete Boolean indicating whether colour aesthetic is discrete or not
#' @param reverse Boolean indicating whether the palette should be reversed
#' @param ... Additional arguments passed to discrete_scale() or
#'            scale_fill_gradient(), used respectively when discrete is TRUE or FALSE
#' @examples
#' # Fill by discrete variable with different palette + remove legend (guide)
#' ggplot2::ggplot(mpg, ggplot2::aes(manufacturer, fill = manufacturer)) + ggplot2::geom_bar() + ggplot2::theme(axis.text.x = ggplot2::element_text(angle = 45, hjust = 1)) + ussc::scale_fill_ussc(palette = "main", guide = "none")
#' # Set colour transparency by calling alpha in the geom_...() command
#' ggplot2::ggplot(mpg, ggplot2::aes(manufacturer, fill = manufacturer)) + ggplot2::geom_bar(alpha=0.7) + ggplot2::theme(axis.text.x = ggplot2::element_text(angle = 45, hjust = 1)) + ussc::scale_fill_ussc(palette = "main", guide = "none")
#' @author
#' Zoe Meers
#' @export
#' 

scale_fill_ussc <- function(palette = "main", discrete = TRUE, reverse = FALSE, ...) {
  pal <- ussc_palettes(palette = palette, reverse = reverse)

  if (discrete) {
    ggplot2::discrete_scale("fill", paste0("ussc_", palette), palette = pal, ...)
  } else {
    ggplot2::scale_colour_gradientn(colours = pal(256), ...)
  }
}