R/scales_camp_rio.R

In idea-analytics/ideacolors: Helpers for using IDEA colors with ggplot2

#' Camp RIO color scale palette for ggplot2
#'
#' @rdname scale_color_camp_rio
#'
#' @param palette Choose from 'camp_rio_palettes_2022' list
#'
#' @param reverse logical, Reverse the order of the colours?
#'
#' @param alpha transparency
#'
#' @param discrete whether to use a discrete color palette
#'
#' @param year Defaults to the most recent branding guidelines (year = 2022)
#'
#' @param ... additional arguments to passed to `scale_color_gradientn`
#'
#'
#' @importFrom ggplot2 scale_colour_manual
#'
#' @examples
#' library(ggplot2)
#'
#' ggplot(mtcars, aes(mpg, wt)) +
#'   geom_point(aes(colour = factor(cyl))) +
#'   scale_colour_camp_rio(palette="qual")
#'
#' ggplot(mtcars, aes(mpg, wt)) +
#'   geom_point(aes(colour = hp)) +
#'   scale_colour_camp_rio(palette="qual", discrete = FALSE)
#'
#' ggplot(data = mpg) +
#'   geom_point(mapping = aes(x = displ, y = hwy, color = class)) +
#'   scale_colour_camp_rio(palette="bluegray")

#' @export
#'
#' @importFrom ggplot2 discrete_scale scale_color_gradientn
scale_color_camp_rio <- function(palette="div",
                                 discrete = TRUE,
                                 alpha = 1,
                                 reverse = FALSE,
                                 year = 2022, ...) {
  if (discrete) {
    ggplot2::discrete_scale("colour", "camp_rio", palette=camp_rio_palette_ramp(palette, alpha = alpha, reverse = reverse, year = year), ...)
  } else {
    ggplot2::scale_color_gradientn(colours = camp_rio_palette_ramp(palette, alpha = alpha, reverse = reverse, year = year, ...)(256))
  }
}

#' @rdname scale_color_camp_rio
#' @export
scale_colour_camp_rio <- scale_color_camp_rio



#' Camp RIO fill palette for ggplot2
#'
#' @param palette Choose from 'idea_palettes' list
#'
#' @inheritParams viridis::scale_fill_viridis
#' @inheritParams idea_palette_ramp
#'
#' @param discrete whether to use a discrete colour palette
#'
#' @param ... additional arguments to pass to scale_color_gradientn
#'
#' @examples
#' library(ggplot2)
#' ggplot(diamonds) +
#'   geom_bar(aes(x = cut, fill = clarity)) +
#'   scale_fill_camp_rio()
#'
#' @importFrom ggplot2 scale_fill_manual discrete_scale scale_fill_gradientn
#' @importFrom viridis scale_fill_viridis
#'
#' @export
scale_fill_camp_rio <- function(palette="div",
                                discrete = TRUE,
                                alpha=1,
                                reverse = TRUE,
                                year = 2022, ...) {
  if (discrete) {
    discrete_scale("fill", "camp_rio", palette=camp_rio_palette_ramp(palette, alpha = alpha, reverse = reverse, year = year), ...)
  }
  else {
    scale_fill_gradientn(colours = camp_rio_palette_ramp(palette, alpha = alpha, reverse = reverse, year = year)(256), ...)
  }
}