Assert special color inputs — assert_color

Usage

assert_color_options(color_low = NULL, color_high = NULL, viridis = NULL)

Arguments

color_low, color_high: (Optional) A character vector representing color names or hexadecimal color codes (Default: NULL).
viridis: (Optional) A character vector representing viridis color palette names (Default: NULL).

Value

An invisible TRUE if the input is valid; an error message otherwise.

Details

assert_color_options() ensures that the provided color options are valid. It checks if the color_low and color_high arguments are valid colors and are provided together, or, alternatively, ensures that viridis color palette names are valid. These options are mutually exclusive.

Examples

assert_color_options(color_low = "#FF5733", color_high = "#33FF57")

assert_color_options(
  color_low = c("#FF5733", "#FFF"),
  color_high = c("#33FF57", "#000")
)

assert_color_options(viridis = "magma")
assert_color_options(viridis = c("magma", "viridis"))