Help for package colorBlindness

Type:

Package

Title:

Safe Color Set for Color Blindness

Version:

0.1.9

Description:

Provide the safe color set for color blindness, the simulator of protanopia, deuteranopia. The color sets are collected from: Wong, B. (2011) <doi:10.1038/nmeth.1618>, and http://mkweb.bcgsc.ca/biovis2012/. The simulations of the appearance of the colors to color-deficient viewers were based on algorithms in Vienot, F., Brettel, H. and Mollon, J.D. (1999) <doi:10.1002/(SICI)1520-6378(199908)24:4%3C243::AID-COL5%3E3.0.CO;2-3>. The cvdPlot() function to generate 'ggplot' grobs of simulations were modified from https://github.com/clauswilke/colorblindr.

Depends:

R(≥ 3.6)

Imports:

ggplot2, grDevices, methods, cowplot, colorspace, graphics, gridGraphics, gtable, grid

Suggests:

knitr, reshape2, stats, png, markdown, rmarkdown

biocViews:

Visualization

License:

GPL-2 | GPL-3 [expanded from: GPL (≥ 2)]

Encoding:

UTF-8

VignetteBuilder:

knitr

RoxygenNote:

7.1.1

NeedsCompilation:

Packaged:

2021-04-17 01:32:27 UTC; jianhongou

Author:

Jianhong Ou

[aut, cre]

Maintainer:

Jianhong Ou <jianhong.ou@duke.edu>

Repository:

CRAN

Date/Publication:

2021-04-17 04:50:05 UTC

safe colors

Description

color blindness safe colors

Usage

BLACK

ORANGE

SKY_BLUE

BLUISH_GREEN

YELLOW

BLUE

VERMILLION

REDDISH_PURPLE

safeColors

Format

An object of class character of length 1.

An object of class character of length 8.

References

Wong, B. (2011) <doi:10.1038/nmeth.1642> Wong, B. (2011) <doi:10.1038/nmeth.1618>

Examples

safeColors

available colors

Description

export available colors

Usage

availableColors()

Value

a character vector contain safe colors.

Examples

availableColors()

Available color palette

Description

List all the available color palettes.

Usage

availablePalette()

Value

a character vector contain available color palettes.

Examples

availablePalette()

available color variable

Description

export available color names

Usage

colorNames()

Value

a character vector contain safe colors.

Examples

colorNames()

Show color-deficiency simulations of a plot

Description

Plot the color-deficiency simulations for ggplot grob.

Usage

cvdPlot(
  plot = last_plot(),
  layout = c("origin", "deuteranope", "protanope", "desaturate")
)

Arguments

plot

The grob to be plotted.

layout

The sub-figure types. the choices are origin, deuteranope, protanope, desaturate, and enhanced, enhanced.deuteranope, enhanced.protanope, enhanced.desaturate.

Details

This function is modified from <https://github.com/clauswilke/colorblindr>

Value

An object of ggplot.

Examples

cvdPlot(displayColors(safeColors))
cvdPlot(displayColors(paletteMartin))

simulate color vision deficiency

Description

Transformation of R colors by simulating color vision deficiencies.

Usage

cvdSimulator(col, type = "deuteranope")

Arguments

col

character. A vector of colors.

type

Deficiency type, "protanope" or "deuteranope"

Details

Here use Vienot's methods but not Gustavo's methods (implemented in colorspace::simulate_cvd).

Value

colors.

References

Vienot, F., Brettel, H. and Mollon, J.D. (1999) <doi:10.1002/(SICI)1520-6378(199908)24:4 Sharma, G., Wu, W. and Dalal, E.N. (2005) <doi:10.1002/col.20070>

Examples

cvdSimulator(safeColors)

Display available palette

Description

Display all the available color palettes.

Usage

displayAvailablePalette(...)

Arguments

...

parameters could be used by geom_tile.

Value

an ggplot object

Examples

displayAvailablePalette()

display colors

Description

Display the given colors

Usage

displayColors(col, ...)

displayAllColors(col, types = c("deuteranope", "protanope", "desaturate"), ...)

Arguments

col

color set to display

...

parameters could be used by geom_tile.

types

the type of color vision deficiency.

Value

an ggplot object

Examples

displayColors(safeColors)
displayColors(paletteMartin)
displayAllColors(safeColors, color="white")
displayAllColors(paletteMartin, color="white")

convert plot to grob

Description

use grid.grabExpr or plot_to_gtable to convert plot to grob

Usage

grobify(plot)

Arguments

plot

plots

Value

grob object.

Palette for color blindness

Description

The palette could be used for heatmap or pie graph

Usage

paletteMartin

Green2Magenta16Steps

Blue2DarkRed12Steps

Blue2DarkRed18Steps

Blue2OrangeRed14Steps

Blue2DarkOrange12Steps

Blue2DarkOrange18Steps

Blue2Green14Steps

Brown2Blue10Steps

Brown2Blue12Steps

Blue2Gray8Steps

Blue2Orange8Steps

Blue2Orange10Steps

Blue2Orange12Steps

ModifiedSpectralScheme11Steps

LightBlue2DarkBlue7Steps

LightBlue2DarkBlue10Steps

PairedColor12Steps

SteppedSequential5Steps