Skip to contents

Flexible colour palettes

Source: R/pal_waratah.R
pal_waratah.Rd

Unlike pal_nsw(), pal_waratah() is not based strictly on the NSW colour palette grids. It tries to choose colours that are perceptually distinct, optionally taking into account colour-blindness when doing so.

Usage

pal_waratah(
  type = c("qual", "seq", "div", "pairs", "triples"),
  hue = 1,
  cvd = getOption("waratah.cvd", default = FALSE),
  variant = getOption("waratah.colour_theme", default = "base"),
  direction = 1
)

Arguments

type

type of palette that should be generated:

  • "qual" discrete qualitative palette

  • "seq" continuous sequential palette: a gradient spanning extreme tones of hue

  • "div" continuous diverging palette: a gradient spanning extreme tones of hue and a second distinct colour.

  • "pairs", "triples" like `"qual"“ but in sets of 2 or 2 tones of each hue.

hue

main hue, either by name of index. See col_nsw() for supported values. Only used when type is "seq" or "div".

cvd

when TRUE account for colour vision disorders. Requires the colorBlindness package.

variant

name of palette variant. Available options are: base, aboriginal, corporate, treasury. Ignored unless hue or tone is specified.

direction

set to -1 to reverse the order of colours in the palette, or 1 for the original order.

Value

A palette object (see palette constructors)

See also

Other palettes: pal_nsw()

Examples

library(scales)

pal_waratah("qual") |> show_col()

pal_waratah("pairs") |> show_col()

pal_waratah("seq", hue = "red") |> show_col(labels = FALSE)

pal_waratah("div", hue = "yellow", variant = "aboriginal") |>
  show_col(labels = FALSE)