R/color_palette.R

In maxsonBraunLab/CITE-Viz: "CITEViz: Classifying Cell Clusters in CITE-Seq Data using the Flow Cytometry Gating Workflow"

#' Custom color palette with color interpolation to use for QA plots
#'
#' create custom color palette with color interpolation to use for QA plots
#' interpolate the base color palette so that exact number of colors in custom palette is same as number of unique values for selected metadata category
#' takes in an integer argument for number of colors to generate in palette (default is 3)
#' returns a character vector of color hex codes for the desired number of colors
#'
#' @param num_colors number of colors
#'
#' @importFrom grDevices colorRampPalette
#' @noRd
#'
#' @return A color palette in the form of a character vector of hex color codes.
get_palette <- function(num_colors = 3) {
    base_palette <- grDevices::colorRampPalette(colors = c(
        "turquoise3",
        "darkgreen",
        "red",
        "royalblue1",
        "orange2",
        "lightseagreen",
        "yellow",
        "royalblue4",
        "yellow3",
        "darkorchid1",
        "lawngreen",
        "magenta3"
    ))
    return(base_palette(num_colors))
}