---
title: "colorblindcheck: Check Color Palettes for Problems with Color Vision Deficiency"
author: "Jakub Nowosad"
date: "`r Sys.Date()`"
output: rmarkdown::html_vignette
vignette: >
  %\VignetteIndexEntry{intro-to-colorblindcheck}
  %\VignetteEngine{knitr::rmarkdown}
  %\VignetteEncoding{UTF-8}
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>"
)
```

Deciding if a color palette is a colorblind friendly is a hard task.
This cannot be done in an entirely automatic fashion, as the decision needs to be confirmed by visual judgments.
The goal of **colorblindcheck** is to provide tools to decide if the selected color palette is colorblind friendly, including:

- `palette_dist()` - Calculation of the distances between the colors in the input palette and between the colors in simulations of the color vision deficiencies - deuteranopia, protanopia, and tritanopia.
- `palette_plot()` - Plotting of the original input palette and simulations of color vision deficiencies - deuteranopia, protanopia, and tritanopia.
- `palette_check()` - Creating summary statistics comparing the original input palette and simulations of color vision deficiencies - deuteranopia, protanopia, and tritanopia.

The work in this package was inspired by [a blog post by Gregor Aisch](https://www.datawrapper.de/blog/colorblind-check).

## Example

The **colorblindcheck** accepts a vector of hexadecimal color descriptions as the input. 
It can be created using different existing R functions (e.g. `rainbow()`) or packages (e.g. [**colorspace**](https://cran.r-project.org/package=colorspace), [**RColorBrewer**](https://cran.r-project.org/package=RColorBrewer), [**rcartocolor**](https://cran.r-project.org/package=rcartocolor), etc.).

```{r}
library(colorblindcheck)
rainbow_pal = rainbow(n = 7)
rainbow_pal
```

The primary function in this package is `palette_check()`, which creates a summary comparison between the original input palette and simulations of color vision deficiencies - deuteranopia, protanopia, and tritanopia.

```{r, fig.width=6}
palette_check(rainbow_pal, plot = TRUE)
```

The `palette_check()` function returns a data.frame with 4 observations and 8 variables:

* `name`: original input color palette (normal), deuteranopia, protanopia, and tritanopia
* `n`: number of colors
* `tolerance`: minimal value of the acceptable difference between the colors to distinguish between them
* `ncp`: number of color pairs
* `ndcp`: number of differentiable color pairs (color pairs with distances above the tolerance value)
* `min_dist`: minimal distance between colors
* `mean_dist`: average distance between colors
* `max_dist`: maximal distance between colors

Additionally, a plot comparing the original input palette and simulations of color vision deficiencies - deuteranopia, protanopia, and tritanopia can be shown.
This help to decide if the selected color palette is colorblind friendly.

For example, the above output shows that the minimal distance between colors in the input palette is about 12; however, the minimum distance between colors simulation of tritanopia is only about 2.
It can suggest that some colors in this palette would not be distinguishable by people with color vision deficiencies.

The `palette_dist()` function calculates distances between the colors in the input palette, as well as in a simulation of the selected color vision deficiency - deuteranopia, protanopia, and tritanopia.
It allows finding which colors are the most or the least similar and to compare the behavior of color palettes for different color vision deficiencies.
In the original `rainbow_pal` object, the closest colors were the third and the fourth one (a distance of about 12); however, the deuteranopia version has a minimal distance of 3 between the second and third color.

```{r}
# normal
palette_dist(rainbow_pal)
# deuteranopia
palette_dist(rainbow_pal, cvd = "pro")
```
