R/gg_color_hue.R

In metafolio: Metapopulation Simulations for Conserving Salmon Through Portfolio Optimization

#' ggplot2-like colour scale in HCL space
#'
#' @param n Number of colours to return.
#' @param hue_min Minimum hue value in the range [0,360]
#' @param hue_max Maximum hue value in the range [0,360]
#' @param l Luminance in the range [0,100]
#' @param c Chroma of the colour.
#' @details See the \code{\link[grDevices]{hcl}} function for details.
#' @export
#' @examples
#' gg_color_hue(10)
#' @return A vector of colour values.

gg_color_hue <- function(n, hue_min = 10, hue_max = 280, l = 62, c = 100) {
  hues = seq(hue_min, hue_max, length=n+1)
  hcl(h=hues, l=l, c=c)[1:n]
}