R/californication_palette.R

In johnmackintosh/rockthemes: Colour palettes based on classic rock album covers

californication_palette <- c(
    "#e0dcc2", 
    "#88b1c1", 
    "#23ccfa", 
    "#b77d65",
    "#db263a",
    "#e05b1d",
    "#1285da",
    "#28229a",
    "#51473f",
    "#1c150f"
)

#' @title californication palette
#' @description californication palette
#' @inheritDotParams ggplot2::discrete_scale
#' @param n number of colors
#' @param type discrete or continuous
#' @param reverse reverse order, Default: FALSE
#' @rdname californication_pal
#' @examples
#' library(scales)
#' show_col(californication_pal()(10))
#' @export
#' @importFrom scales manual_pal
#' @importFrom glue glue
#' @importFrom grDevices colorRampPalette

californication_pal <- function(n, type = c("discrete", "continuous"),
                          reverse = FALSE){
    californication <- californication_palette
    
    if (reverse == TRUE) {
        californication <- rev(californication)
    }
    
    if (missing(n)) {
        n <- length(californication)
    }
    
    type <- match.arg(type)
    
    if (type == "discrete" && n > length(californication)) {
        stop(glue::glue("Palette does not have {n} colors, maximum is {length(californication)}!"))
    }
    
    californication <- switch(type,
                        continuous = grDevices::colorRampPalette(californication)(n),
                        discrete = californication[1:n])
    
    californication <- scales::manual_pal(californication)
    
    return(californication)
}

#' @title scale_color_californication
#' @rdname californication_pal
#' @export
#' @examples
#'
#' library(ggplot2)
#' ggplot(airquality, aes(x = Day, y = Temp,
#'      group = as.factor(Month), color = as.factor(Month))) +
#'      geom_point(size = 2.5) +
#'      scale_color_californication()
#' @importFrom ggplot2 discrete_scale scale_color_gradientn

scale_color_californication <- function(n, type = "discrete",
                                  reverse = FALSE, ...){
    if (type == "discrete") {
        ggplot2::discrete_scale("color", "californication",
                                californication_pal(n = n, type = type,
                                              reverse = reverse), ...)
    } else {
        ggplot2::scale_color_gradientn(colors = californication_pal(n = n, type = type,
                                                              reverse = reverse)(256))
    }
}

#' @title scale_colour_californication
#' @rdname californication_pal
#' @export
#' @examples
#'
#' ggplot(airquality, aes(x = Day, y = Temp,
#'      group = as.factor(Month), color = as.factor(Month))) +
#'      geom_point(size = 2.5) +
#'      scale_colour_californication()
#' @importFrom ggplot2 discrete_scale scale_color_gradientn

scale_colour_californication <- scale_color_californication

#' @title scale_fill_californication
#' @rdname californication_pal
#' @export
#' @examples
#'
#' ggplot(mpg, aes(displ)) +
#'     geom_histogram(aes(fill = class),
#'                    col = "black", size = 0.1) +
#'     scale_fill_californication()
#' @importFrom ggplot2 discrete_scale scale_fill_gradientn

scale_fill_californication <- function(n, type = "discrete",
                                 reverse = FALSE, ...){
    if (type == "discrete") {
        ggplot2::discrete_scale("fill", "californication",
                                californication_pal(n = n, type = type,
                                              reverse = reverse), ...)
    } else {
        ggplot2::scale_fill_gradientn(colors = californication_pal(n = n, type = type,
                                                             reverse = reverse)(256))
    }
}