slot_colors: Slot a set of colors into a reference set of colors

In jmw86069/colorjam: Jam Color manipulation functions

Slot a set of colors into a reference set of colors

Description

Slot a set of colors into a reference set of colors

Usage

slot_colors(
  given_colors,
  ref_colors,
  dist_threshold = NULL,
  min_distance = 11.5,
  return_type = c("list", "vector"),
  use_white = "F5",
  method = "cie2000",
  do_plot = FALSE,
  verbose = FALSE,
  ...
)

Arguments

given_colors	character vector of given colors to test versus ref_colors. Colors in given_colors which are within the distance threshold of one or more colors in ref_colors are assigned (slotted) into those colors.
ref_colors	character vector of reference colors.
dist_threshold	numeric default NULL, with pre-defined color distance threshold.
min_distance	numeric default 11.5 with a minimum distance to use, when the dynamic distance threshold is below this value, and when dist_threshold is not provided.
return_type	character string, default 'list' with return type: 'list': returns list with length(given_colors) and integer values of assigned colors in ref_colors, or NA when no values in ref_colors are within the distance threshold. vector: returns vector equivalent of the list output, flattened using jamba::cPaste(). Values are NA or 'NA' for unslotted colors.
use_white	character default "F5" representing the white reference, any value recognized by farver::as_white_ref(). The default 'F5' represents 'daylight fluorescent' and in qualitative testing was most effective when defining color distances. The typical default 'D65' is 'daylight 6500K' and is typically used for neutral daylight without blue (cool) or yellow (warm) shifted background lighting.
method	character default 'cie2000' passed to color_distance()
do_plot	logical default FALSE, whether to plot a visual of the slot colors assignments.
verbose	logical indicating whether to print verbose output.
...	additional arguments are passed to internal functions color_distance(), or when do_plot==TRUE, imageByColors().

Details

The primary purpose is for add_colors() to determine whether a given set of colors given_colors are already represented, within a given color tolerance or distance, within a reference set of colors ref_colors.

Colors are "slotted" into the corresponding reference colors, and un-slotted colors can be considered "not used" in the reference colors, and therefore they are available to be new colors to add to the set.

add_colors() is recommended for most users, since it applies the logic by calling slot_colors() itself. However, for debugging, in order to understand why certain colors are "slotted" and other colors are not, slot_colors() may be useful to call directly, especially with do_plot=TRUE for visual review.

Color distance metrics are imperfect, and do not represent color blindness conditions effectively. Further, color distance metrics are designed with different goals in mind. For example the typical metrics are designed to ensure tolerance to a standard color. They are not primarily designed to quantify the magnitude of perceptible difference between two colors, and this latter scenario is the primary motivation of slot_colors() and add_colors().

Value

list with length(given_colors) with integer vectors referencing one or more elements in ref_colors, or NULL.

Examples

given_colors <- rainbowJam(5)
ref_colors <- colorspace::rainbow_hcl(6)
slot_colors(given_colors, ref_colors, do_plot=TRUE)

given_colors <- rainbowJam(5)
ref_colors <- colorspace::rainbow_hcl(16)
slot_colors(given_colors, ref_colors, verbose=TRUE, do_plot=TRUE)

jmw86069/colorjam documentation built on June 10, 2025, 12:02 p.m.