R/get_colours.R

In 2DegreesInvesting/r2dii.colours: 2 Degrees Investing Colour Palettes in Different Formats

#' Retrieve colour hex values from a palette
#'
#' @param colour_names Character string or a vector of character strings with
#'   names of colours for which you want to retrieve the hex values.
#' @param palette The dataframe from which the hex values are retrieved. It
#'   should contain columns `label` and `hex`.
#'
#' @return A vector of strings with hex codes in order specified by
#'   `colour_names`.
#' @export
#'
#' @examples
#' # use default palette
#' get_colours(c("red", "blue"))
#'
#' # specify which palette to use
#' get_colours(c("red", "green"), palette = palette_1in1000_goodbad)
get_colours <- function(
                        colour_names = "red",
                        palette = r2dii.colours::palette_1in1000_plot) {
  check_colour_name(palette, colour_names)

  colour_hex <- palette %>%
    filter(.data$label %in% colour_names) %>%
    mutate(label = factor(.data$label, levels = colour_names)) %>%
    arrange(.data$label) %>%
    pull(.data$hex)
  colour_hex
}