cols4all (version 0.6)

c4a: Get a cols4all color palette

Description

Get a cols4all color palette: c4a returns the colors of the specified palette, and c4a_na returns the color for missing value that is associated with the specified palette. Run c4a_gui to see all available palettes, which are also listed with c4a_palettes.

Usage

c4a(
  palette = NULL,
  n = NA,
  m = NA,
  type = c("cat", "seq", "div", "bivs", "bivc", "bivd", "bivg"),
  reverse = FALSE,
  order = NULL,
  range = NA,
  format = c("hex", "RGB", "HCL"),
  nm_invalid = c("error", "repeat", "interpolate"),
  verbose = TRUE
)
c4a_na(palette = NULL, type = c("cat", "seq", "div"), verbose = TRUE)

Value

A vector of colors (c4a) and a color (c4a_na)

Arguments

palette

name of the palette. See c4a_palettes for options. If omitted, the default palette is provided by c4a_default_palette. The palette name can be prefixed with a "-" symbol, which will reverse the palette (this can also be done with the reverse argument).

n

number of colors. If omitted then: for type "cat" the maximum number of colors is returned, for types "seq" and "div", 9 colors.

m

number of rows in case type is "bivs", "bivc", "bivd" or "bivg" (which stand for respectively sequential, categorical, diverging and desaturated (g for 'grayscale')).

type

type of color palette, in case palette is not specified: one of "cat" (categorical/qualitative palette), "seq" (sequential palette), "div" (diverging palette), and "bivs"/"bivc"/"bivd"/"bivg" (bivariate: respectively seq-seq seq-cat, seq-div, and seq-desaturated).

reverse

should the palette be reversed?

order

order of colors. Only applicable for "cat" palettes

range

a vector of two numbers between 0 and 1 that determine the range that is used for sequential and diverging palettes. The first number determines where the palette begins, and the second number where it ends. For sequential "seq" palettes, 0 means the leftmost (normally lightest) color, and 1 the rightmost (often darkest) color. For diverging "seq" palettes, 0 means the middle color, and 1 both extremes. If only one number is provided, this number is interpreted as the endpoint (with 0 taken as the start).

format

format of the colors. One of: "hex" character vector of hex color values, "RGB" 3 column matrix of RGB values, or "HCL" 3-column matrix of HCL values

nm_invalid

what should be done in case n or m is larger than the maximum number of colors or smaller than the minimum number? Options are "error" (an error is returned), "repeat", the palette is repeated, "interpolate" colors are interpolated. For categorical "cat" palettes only.

verbose

should messages be printed?

Examples

c4a_palettes("div")

c4a(type = "cat")

(pal = c4a("tol.sunset", n = 7, range = c(0, .6)))

c4a_plot(pal)

c4a("set2")

c4a("hcl.set2")

c4a("hcl.set2", n = 8)

# reversed palette
c4a("hcl.set2", reverse = TRUE, n = 8)

# handy shortcut
c4a("-hcl.set2", n = 8)

# the color for missing values is white:
c4a_na("hcl.set2")