R/palette_spongebob.R

In tvthemes: TV Show Themes and Color Palettes for 'ggplot2' Graphics

spongeBob_palette <- c(
  "#C86925",  ## brownpants
  "#FDF56C",  ## sponge yellow
  "#FC9576",  ## patrick pink
  "#5D57AF",  ## patrick purple
  "#B2CE31",  ## patrick green
  "#FF2027",  ## mr.krabs red
  "#B1D6C5",  ## squidward blue
  "#AB8323",  ## squidward shirt brown
  "#000000"   ## black
)


#C86925  ## brownpants
#FDF56C  ## sponge yellow
#C4433F  ## sponge tie red
#989B46  ## kelp green
#FC9576  ## patrick pink
#5D57AF  ## patrick purple
#B2CE31  ## patrick green
#FF2027  ## mr.krabs red
#000000  ## black
#B1D6C5  ## squidward blue
#AB8323  ## squidward shirt brown

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

spongeBob_pal <- function(n, type = c("discrete", "continuous"),
                          reverse = FALSE){
  spongeBob <- spongeBob_palette

  if (reverse == TRUE) {
    spongeBob <- rev(spongeBob)
  }

  if (missing(n)) {
    n <- length(spongeBob)
  }

  type <- match.arg(type)

  if (type == "discrete" && n > length(spongeBob)) {
    stop(paste0("Palette does not have ", n, " colors, maximum is ", length(spongeBob), "!"))
  }

  spongeBob <- switch(type,
                     continuous = grDevices::colorRampPalette(spongeBob)(n),
                     discrete = spongeBob[1:n])

  spongeBob <- scales::manual_pal(spongeBob)

  return(spongeBob)
}

#' @title scale_color_spongeBob
#' @rdname spongeBob_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_spongeBob()
#' @importFrom ggplot2 discrete_scale scale_color_gradientn

scale_color_spongeBob <- function(n, type = "discrete",
                                  reverse = FALSE, ...){
  if (type == "discrete") {
  ggplot2::discrete_scale("color", "spongeBob", spongeBob_pal(), ...)
  } else { ## needs work...
    ggplot2::scale_color_gradientn(colors = spongeBob_pal(n = n, type = type,
                                                         reverse = reverse)(8))
  }
}

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

scale_colour_spongeBob <- scale_color_spongeBob

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

scale_fill_spongeBob <- function(n, type = "discrete",
                                 reverse = FALSE, ...){
  if (type == "discrete") {
  ggplot2::discrete_scale("fill", "spongeBob", spongeBob_pal(), ...)
  } else { ## needs work...
    ggplot2::scale_fill_gradientn(colors = spongeBob_pal(n = n, type = type,
                                                          reverse = reverse)(8))
  }

}