From 0aed1ec56f24ca53f5ecaa05de463ffd4ea7e673 Mon Sep 17 00:00:00 2001 From: mtennekes Date: Wed, 16 Oct 2024 22:13:40 +0200 Subject: [PATCH] updated readme vignette images urls --- README.Rmd | 19 +++++++++---------- README.md | 34 +++++++++++++++++----------------- 2 files changed, 26 insertions(+), 27 deletions(-) diff --git a/README.Rmd b/README.Rmd index 621828b..8874c13 100644 --- a/README.Rmd +++ b/README.Rmd @@ -64,7 +64,6 @@ install.packages("remotes") remotes::install_github("mtennekes/cols4all", dependencies = TRUE) ``` -This development version will be on CRAN soon (October 2024) ```{r, echo=FALSE, message=FALSE} @@ -86,7 +85,7 @@ The main tool is a dashboard, which is started with: c4a_gui() ``` -[](vignettes/cols4all2.jpg) +[](vignettes/articles/cols4all2.jpg) What palettes are available? That is, by default; other palettes can be added! @@ -114,7 +113,7 @@ Find a trade-off you like among the following properties (the columns in the mai When we are looking for a fair categorical palette of seven colors that is as color blind friendly as possible, then filter on "Fair", and sort by "Colorblind-friendly": -[](vignettes/cols4all_fair_sort_cbf.jpg) +[](vignettes/articles/cols4all_fair_sort_cbf.jpg) This inspired us to develop our own palettes: see these `cols4all` palettes below. @@ -123,7 +122,7 @@ This inspired us to develop our own palettes: see these `cols4all` palettes belo Say we need a diverging palette that is color blind friendly, and what to choose one by eye. Then filter by "Colorblind-friendly" and sort by "Hue Middle L" (the hue of the left wing): -[](vignettes/cols4all_div.jpg) +[](vignettes/articles/cols4all_div.jpg) Reverse sorting is also applied. @@ -131,25 +130,25 @@ Reverse sorting is also applied. We applied a basic heuristic to explore palettes that score well on a mix of the properties named above -[](vignettes/c4a_pals.jpg) +[](vignettes/articles/c4a_pals.jpg) `area7`, `area8` and `area9` are fair, contain low pastel colors, and are color-blind friendly (up to 7 colors). So ideal for maps and other space-filling visualizations! These are used in [https://github.com/r-tmap/tmap](`tmap4`). -[](vignettes/area7.jpg) +[](vignettes/articles/area7.jpg) `area7d`, `area8d` and `area9d` similar but for dark mode:. -[](vignettes/area7d.jpg) +[](vignettes/articles/area7d.jpg) `line7`, `line8` and `line9` are colors with good contrast against both black and white, and are also colorblind-friendly to some extent. So ideal for line graphs and scatter plots: -[](vignettes/line7_wt.jpg) -[](vignettes/line7_bk.jpg) +[](vignettes/articles/line7_wt.jpg) +[](vignettes/articles/line7_bk.jpg) Finally `friendly7` ... `friendly13` are colorblind-friendly palettes (disregarding the other properties): -[](vignettes/friendly13.jpg) +[](vignettes/articles/friendly13.jpg) diff --git a/README.md b/README.md index 5ee065b..09a1f68 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ checks](https://cranchecks.info/badges/worst/cols4all)](https://cran.r-project.o all” refers to our mission that colors should be usable for not just people with normal color vision, but also for people with color vision deficiency. Currently, this package contains palettes from several -popular and lesser known color palette series. Own palettes series can -be added as well. +popular and lesser known color palette series. Users can also add their +own palette series. Color palettes are well organized and made consistent with each other. Moreover, they are scored on several aspects: color-blind-friendliness, @@ -59,7 +59,7 @@ The main tool is a dashboard, which is started with: c4a_gui() ``` -[](vignettes/cols4all2.jpg) +[](vignettes/articles/cols4all2.jpg) What palettes are available? That is, by default; other palettes can be added! @@ -113,50 +113,50 @@ When we are looking for a fair categorical palette of seven colors that is as color blind friendly as possible, then filter on “Fair”, and sort by “Colorblind-friendly”: -[](vignettes/cols4all_fair_sort_cbf.jpg) +[](vignettes/articles/cols4all_fair_sort_cbf.jpg) -This gave us inspiration to develop own palettes: see these `cols4all` +This inspired us to develop our own palettes: see these `cols4all` palettes below. ### Example 2 Say we need a diverging palette that is color blind friendly, and what to choose one by eye. Then filter by “Colorblind-friendly” and sort by -“Huddle Middle L” (the hue of the left wing): +“Hue Middle L” (the hue of the left wing): -[](vignettes/cols4all_div.jpg) +[](vignettes/articles/cols4all_div.jpg) Reverse sorting is also applied. ## Preliminary set of new `cols4all` palettes -We applied a basic heuristics to explore palettes that score well on a +We applied a basic heuristic to explore palettes that score well on a mix of the properties named above -[](vignettes/c4a_pals.jpg) +[](vignettes/articles/c4a_pals.jpg) `area7`, `area8` and `area9` are fair, contain low pastel colors, and are color-blind friendly (up to 7 colors). So ideal for maps and other space-filling visualizations! These are used in [https://github.com/r-tmap/tmap](%60tmap4%60). -[](vignettes/area7.jpg) +[](vignettes/articles/area7.jpg) `area7d`, `area8d` and `area9d` similar but for dark mode:. -[](vignettes/area7d.jpg) +[](vignettes/articles/area7d.jpg) `line7`, `line8` and `line9` are colors with good contrast against both black and white, and are also colorblind-friendly to some extent. So ideal for line graphs and scatter plots: -[](vignettes/line7_wt.jpg) -[](vignettes/line7_bk.jpg) +[](vignettes/articles/line7_wt.jpg) +[](vignettes/articles/line7_bk.jpg) Finally `friendly7` … `friendly13` are colorblind-friendly palettes (disregarding the other properties): -[](vignettes/friendly13.jpg) +[](vignettes/articles/friendly13.jpg) ## `ggplot2` integration @@ -223,7 +223,7 @@ ggplot2 - `scale___c4a_` e.g. `scale_color_continuous_c4a_div` Add scale to ggplot2. -## Other R funtions +## Other R functions What palettes are available, e.g diverging from the hcl series? @@ -264,10 +264,10 @@ package to analyse colors. For this purpose and specifically for color blind friendliness checks, we also use [**colorblindcheck**](https://github.com/Nowosad/colorblindcheck). -There are a few other pacakges with a large collection of color +There are a few other packages with a large collection of color palettes, in particular [**pals**](https://kwstat.github.io/pals/) and [**paletteer**](https://github.com/EmilHvitfeldt/paletteer). There are a -few features that distinguishes **cols4all** from those packages: +few features that distinguish **cols4all** from those packages: - Color palettes are characterized and analysed. Properties such as color blindness, fairness (whether colors stand out about equally),