generate_palette: Generate a monochrome palette

Description Usage Arguments Value Examples

View source: R/generate_palette.R

Description

This function allows users generate a monochrome colour palette containing any number of colours, starting from the colour they specify. The modification parameter can be set to make the palette go darker, lighter, or both ways from the starting colour. The function also allows users to create a palette that goes from one colour to another, by providing a blend_colour.

Usage

1
2
3
4
5
6
7
8
9
generate_palette(
  colour,
  modification,
  n_colours,
  blend_colour = NULL,
  view_palette = FALSE,
  view_labels = TRUE,
  ...
)

Arguments

colour

The starting colour for the palette, which must be either be a recognised colour name (e.g. "white"), a hex colour code (e.g. "#ffffff") or vector of length 3 (red value, green value, blue value, e.g. c(15, 75, 99)), with all values between 0 and 255.

modification

One of the following: "go_darker", "go_lighter", "go_both_ways", or "blend". If a blend_colour is supplied, modification is automatically set to "blend".

n_colours

Number of colours (levels) required in the palette

blend_colour

Optional. Can be either be a recognised colour name (e.g. "white"), a hex colour code (e.g. "#ffffff") or vector of length 3 (red value, green value, blue value, e.g. c(15, 75, 99)), with all values between 0 and 255.

view_palette

Logical. view_palette = TRUE displays the palette in the plot window.

view_labels

Logical. If view_palette is set to TRUE, view_labels = FALSE determines whether or not the hex colour codes are shown on the palette displayed in the plot window.

...

Allows for US spelling of color/colour.

Value

A vector of hex colour codes making up the generated palette

Examples

1
2
3
4
5
6
7
8
generate_palette("red", modification = "go_lighter",
n_colours = 5, view_palette = TRUE, view_labels = TRUE)

generate_palette(c(15, 75, 99), modification = "go_both_ways",
n_colours = 12, view_palette = TRUE, view_labels = FALSE)

generate_palette("red", blend_colour = "blue",
n_colours = 6, view_palette = TRUE)

monochromeR documentation built on Dec. 20, 2021, 5:07 p.m.