R/palettes.R

In CCMH-PSU/CCMHr: CCMH Data Cleaning

#' CCMH palettes
#'
#' Palettes for CCMH.
#'
#' @format ## `CCMH_palettes`
#' An object of class `palettes_palette` with `r length(CCMH_palettes)`
#' colour palettes. Use `names(CCMH_palettes)` to return all palette names.
#' @examples
#' # Get all palettes by name.
#' names(sunset_palettes)
#'
#' # Plot all palettes.
#' plot(CCMH_palettes)
"CCMH_palettes"

#' @rdname CCMH_palettes
#' @format ## `CCMH_institutional_palettes`
#' An object of class `palettes_palette` with
#' `r length(CCMH_institutional_palettes)` discrete colour palettes.
#'  Use `names(CCMH_institutional_palettes)` to return all palette names.
"CCMH_institutional_palettes"

#' @rdname CCMH_palettes
#' @format ## `CCMH_categorical_palettes`
#' An object of class `palettes_palette` with
#' `r length(CCMH_categorical_palettes)` sequential colour palettes.
#'  Use `names(CCMH_categorical_palettes)` to return all palette names.
"CCMH_categorical_palettes"

#' @rdname CCMH_palettes
#' @format ## `CCMH_gradient_palettes`
#' An object of class `palettes_palette` with
#' `r length(CCMH_gradient_palettes)` sequential colour palettes.
#'  Use `names(CCMH_gradient_palettes)` to return all palette names.
"CCMH_gradient_palettes"

#' @rdname CCMH_palettes
#' @format ## `CCMH_diverging_palettes`
#' An object of class `palettes_palette` with
#' `r length(CCMH_diverging_palettes)` sequential colour palettes.
#'  Use `names(CCMH_diverging_palettes)` to return all palette names.
"CCMH_diverging_palettes"