shared_Rscripts/returnPalette.R

returnPalette <- function(ColorVariable = NULL) {
    # #<---------------------------->
    # # You must include this section when:
    # # Distributing, Using and/or Modifying this code.
    # # Please read and abide by the terms of the included LICENSE.
    # # Copyright 2023, Deepankar Chakroborty, All rights reserved.
    # #
    # #  Author : Deepankar Chakroborty (https://github.com/dchakro)
    # #  Website: https://www.dchakro.com
    # #  Report issues: https://github.com/dchakro/shared_Rscripts/issues
    # #  License: https://github.com/dchakro/shared_Rscripts/blob/master/LICENSE
    # #<---------------------------->
    
    
    # #  PURPOSE:
    # #  Generates an appropriate palette for categorical data based on its length
    
    
    if (class(ColorVariable) == "character") {
        colorsNeeded <- length(unique(ColorVariable))
        if (colorsNeeded < 1) {
            myPalette <- c("#DD0000")
            warning("Nothing to return color for.")
        }
        if (colorsNeeded > 1 & colorsNeeded < 10) {
            myPalette <- palette.colors(n = colorsNeeded,
                                        palette = "Classic Tableau")
        } else if (colorsNeeded >= 10 & colorsNeeded < 18) {
            set.seed(2023)
            myPalette <- c(palette.colors(n = 10,
                                          palette = "Classic Tableau"),
                           palette.colors(n = colorsNeeded - 10,
                                          palette = "Set2"))
            set.seed(2023)
            myPalette <- sample(myPalette)
        } else if (colorsNeeded >= 18) {
            myPalette <- sample(hcl.colors(n = colorsNeeded,
                                           palette = "Spectral"))
        }
    }
    if (class(ColorVariable) == "factor") {
        colorsNeeded <- length(levels(ColorVariable))
        if (colorsNeeded < 1) {
            myPalette <- c("#DD0000")
            warning("Nothing to return color for.")
        }
        if (colorsNeeded > 1 & colorsNeeded < 10) {
            myPalette <- palette.colors(n = colorsNeeded,
                                        palette = "Classic Tableau")
        } else if (colorsNeeded >= 10 & colorsNeeded < 18) {
            set.seed(2023)
            myPalette <- c(palette.colors(n = 10,
                                          palette = "Classic Tableau"),
                           palette.colors(n = colorsNeeded - 10,
                                          palette = "Set2"))
            set.seed(2023)
            myPalette <- sample(myPalette)
        } else if (colorsNeeded >= 18) {
            myPalette <- sample(hcl.colors(n = colorsNeeded,
                                           palette = "Spectral"))
        }
    }
    return(myPalette)
}