colour_values_rgb {colourvalues} | R Documentation |
Maps colours to variables, returning a matrix of RGB(A) values
colour_values_rgb(x, palette = "viridis", na_colour = "#808080FF", alpha = 255, include_alpha = TRUE, ...) color_values_rgb(x, palette = "viridis", na_colour = "#808080FF", alpha = 255, include_alpha = TRUE, ...) ## S3 method for class 'character' colour_values_to_rgb(x, palette, na_colour, alpha, include_alpha, summary = FALSE) ## Default S3 method: colour_values_to_rgb(x, palette, na_colour, alpha, include_alpha, n_summaries = 0, format = TRUE, digits = 2) ## S3 method for class 'logical' colour_values_to_rgb(x, palette, na_colour, alpha, include_alpha, summary = FALSE) ## S3 method for class 'factor' colour_values_to_rgb(x, palette, na_colour, alpha, include_alpha, summary = FALSE) ## S3 method for class 'Date' colour_values_to_rgb(x, palette, na_colour, alpha, include_alpha, n_summaries = 0, format = TRUE) ## S3 method for class 'POSIXct' colour_values_to_rgb(x, palette, na_colour, alpha, 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)
x |
vector of values to map to a colour |
palette |
colour palette. See details and examples |
na_colour |
hex string colour to use for NA values in the form |
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 |
include_alpha |
logical indicating if the returned hex or matrix should include
the alpha values. Defaults to |
... |
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 |
n_summaries |
positive integer. If supplied a summary colour palette will be returned
in a list, containing |
format |
logical indicating if the summary values should be formatted. See details |
digits |
Integer. When summarising a numeric vector you can specify the number of decimal places to include in the summary values |
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.
when summary = TRUE
, the following rules are applied to the summary values
logical vectors are converted to "TRUE" or "FALSE" strings
all other types remain as-is, unless format = T
is used
when format = TRUE
,
numbers are converted to strings with the specified number of decimal places (using digits
argument)
Dates are formatted as "yyyy-mm-dd"
colour_values
colour_values_rgb(1:5) colour_values_rgb(1:5, include_alpha = FALSE) colour_values_rgb(-25:25, n_summaries = 5)