R: Colour Values RGB

colour_values_rgb {colourvalues}

R Documentation

Colour Values RGB

Description

Maps colours to variables, returning a matrix of RGB(A) values

Usage

colour_values_rgb(
  x,
  palette = "viridis",
  alpha = 255,
  na_colour = "#808080FF",
  include_alpha = TRUE,
  ...
)

color_values_rgb(
  x,
  palette = "viridis",
  alpha = 255,
  na_colour = "#808080FF",
  include_alpha = TRUE,
  ...
)

## S3 method for class 'character'
colour_values_to_rgb(
  x,
  palette,
  alpha,
  na_colour,
  include_alpha,
  summary = FALSE
)

## S3 method for class 'logical'
colour_values_to_rgb(
  x,
  palette,
  alpha,
  na_colour,
  include_alpha,
  summary = FALSE
)

## S3 method for class 'factor'
colour_values_to_rgb(
  x,
  palette,
  alpha,
  na_colour,
  include_alpha,
  summary = FALSE
)

## S3 method for class 'Date'
colour_values_to_rgb(
  x,
  palette,
  alpha,
  na_colour,
  include_alpha,
  n_summaries = 0,
  format = TRUE
)

## S3 method for class 'POSIXct'
colour_values_to_rgb(
  x,
  palette,
  alpha,
  na_colour,
  include_alpha,
  n_summaries = 0,
  format = TRUE
)

## S3 method for class 'POSIXlt'
colour_values_to_rgb(
  x,
  palette,
  na_colour,
  alpha,
  include_alpha,
  n_summaries = 0,
  format = TRUE
)

Arguments

`x`	vector of values to map to a colour
`palette`	colour palette. See details and examples
`alpha`	optional. Single value in [0,255] applied to all colours, or a decimal in [0, 1) (to indicate a percentage, noting 1 is excluded), or a vector of numeric values the same length as `x`. The numeric vector will be scaled into the range [0,255]. If a matrix palette is supplied this argument is ignored.
`na_colour`	hex string colour to use for NA values in the form `#RRGGBBAA`.
`include_alpha`	logical indicating if the returned hex or matrix should include the alpha values. Defaults to `TRUE`.
`...`	other arguments possed to methods
`summary`	logical indicating if a summary of the colours should be returned as well as the full colour mapping. This will be the unique elements of `x` mapped to the colour.
`n_summaries`	positive integer. If supplied a summary colour palette will be returned in a list, containing `n_summaries` equally spaced values of `x` in the range `[min(x),max(x)]`, and their associated colours. If a non-numeric `x` is used this value is ignored
`format`	logical indicating if the summary values should be formatted. See details

Details

The palette can either be

String - use colour_palettes() to view available palettes
Matrix - At least 5 rows, and 3 (or 4) columns representing the red, green and blue (and alpha) values

The matrix palette requires 5 rows because the colours are interpolated using a cubic b-spline. This method requires 5 values.

Examples


colour_values_rgb(1:5)
colour_values_rgb(1:5, include_alpha = FALSE)
colour_values_rgb(-25:25, n_summaries = 5)