From 7fb655172f9e968ec0c8c65156c2641610ed0e9b Mon Sep 17 00:00:00 2001 From: olivroy Date: Mon, 21 Oct 2024 13:54:08 -0400 Subject: [PATCH] Move article to vignette + build ignore it --- .Rbuildignore | 2 +- _pkgdown.yml | 1 + vignettes/{articles => }/paper.Rmd | 56 +++++++++++++++--------------- 3 files changed, 30 insertions(+), 29 deletions(-) rename vignettes/{articles => }/paper.Rmd (96%) diff --git a/.Rbuildignore b/.Rbuildignore index 2c30d8b..9033d53 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -16,4 +16,4 @@ ^pkgdown$ ^\.github$ ^man/figures$ -^vignettes/articles$ +^vignettes$ diff --git a/_pkgdown.yml b/_pkgdown.yml index b8c8dba..54236ae 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -2,3 +2,4 @@ url: https://mtennekes.github.io/cols4all/ template: bootstrap: 5 math-rendering: mathjax + assets: pkgdown/assets diff --git a/vignettes/articles/paper.Rmd b/vignettes/paper.Rmd similarity index 96% rename from vignettes/articles/paper.Rmd rename to vignettes/paper.Rmd index c1fdc58..79eaf34 100644 --- a/vignettes/articles/paper.Rmd +++ b/vignettes/paper.Rmd @@ -50,7 +50,7 @@ library(cols4all) #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/cols4all2.jpg") +knitr::include_graphics("../man/figures/cols4all2.jpg") ``` ## Introduction @@ -166,7 +166,7 @@ Palettes are organised by functional type. We distinguish the following types: #| out.width = 400, #| echo = FALSE -knitr::include_graphics("../../man/figures/ex_cat.jpg") +knitr::include_graphics("../man/figures/ex_cat.jpg") ``` ```{r expals2, fig.cap = "Example of palette type: sequential"} @@ -174,7 +174,7 @@ knitr::include_graphics("../../man/figures/ex_cat.jpg") #| out.width = 400, #| echo = FALSE -knitr::include_graphics("../../man/figures/ex_seq.jpg") +knitr::include_graphics("../man/figures/ex_seq.jpg") ``` ```{r expals3, fig.cap = "Example of palette type: diverging"} @@ -182,7 +182,7 @@ knitr::include_graphics("../../man/figures/ex_seq.jpg") #| out.width = 400, #| echo = FALSE -knitr::include_graphics("../../man/figures/ex_div.jpg") +knitr::include_graphics("../man/figures/ex_div.jpg") ``` ```{r expals4, fig.cap = "Example of palette type: cyclic"} @@ -190,7 +190,7 @@ knitr::include_graphics("../../man/figures/ex_div.jpg") #| out.width = 400, #| echo = FALSE -knitr::include_graphics("../../man/figures/ex_cyc.jpg") +knitr::include_graphics("../man/figures/ex_cyc.jpg") ``` ```{r expals5, fig.cap = "Example of palette type: bivariate (seq x seq)"} @@ -198,7 +198,7 @@ knitr::include_graphics("../../man/figures/ex_cyc.jpg") #| out.width = 200, #| echo = FALSE -knitr::include_graphics("../../man/figures/ex_bivs.jpg") +knitr::include_graphics("../man/figures/ex_bivs.jpg") ``` ```{r expals6, fig.cap = "Example of palette type: bivariate (seq x cat)"} @@ -206,7 +206,7 @@ knitr::include_graphics("../../man/figures/ex_bivs.jpg") #| out.width = 200, #| echo = FALSE -knitr::include_graphics("../../man/figures/ex_bivc.jpg") +knitr::include_graphics("../man/figures/ex_bivc.jpg") ``` ```{r expals7, fig.cap = "Example of palette type: bivariate (seq x div)"} @@ -214,7 +214,7 @@ knitr::include_graphics("../../man/figures/ex_bivc.jpg") #| out.width = 200, #| echo = FALSE -knitr::include_graphics("../../man/figures/ex_bivd.jpg") +knitr::include_graphics("../man/figures/ex_bivd.jpg") ``` ```{r expals8, fig.cap = "Example of palette type: bivariate (seq x desaturated)"} @@ -222,7 +222,7 @@ knitr::include_graphics("../../man/figures/ex_bivd.jpg") #| out.width = 200, #| echo = FALSE -knitr::include_graphics("../../man/figures/ex_bivg.jpg") +knitr::include_graphics("../man/figures/ex_bivg.jpg") ``` @@ -392,7 +392,7 @@ To aid decision making a palette is called fair if the fairness score is at leas #| out.width = 300, #| echo = FALSE -knitr::include_graphics("../../man/figures/fairness.jpg") +knitr::include_graphics("../man/figures/fairness.jpg") ``` @@ -441,7 +441,7 @@ For diverging palettes, we calculate the hue widths for both wings. If at least #| out.width = 400, #| echo = FALSE -knitr::include_graphics("../../man/figures/necklace.jpg") +knitr::include_graphics("../man/figures/necklace.jpg") ``` @@ -457,7 +457,7 @@ In the middle column two similarity matrices are shown, above for people with no #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/cbf_okabe.jpg") +knitr::include_graphics("../man/figures/cbf_okabe.jpg") ``` @@ -486,7 +486,7 @@ Figure \@ref(fig:contrast) shows a bar chart of the contrast ratio values of the #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/contrast_powerbi_default.jpg") +knitr::include_graphics("../man/figures/contrast_powerbi_default.jpg") ``` @@ -502,7 +502,7 @@ Several visual illusions could appear at equiluminance, such as that the eye has #| out.width = 700, #| echo = FALSE -knitr::include_graphics(c("../../man/figures/equi1.jpg", "../../man/figures/equi2.jpg")) +knitr::include_graphics(c("../man/figures/equi1.jpg", "../man/figures/equi2.jpg")) ``` @@ -533,7 +533,7 @@ Figure \@ref(fig:3dblues) illustrates this illusion with a categorical map of th #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/3Dblues_map.jpg") +knitr::include_graphics("../man/figures/3Dblues_map.jpg") ``` @@ -578,7 +578,7 @@ The variety of colors shown in the column headings are generated by the specifie #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/naming_tableau10.jpg") +knitr::include_graphics("../man/figures/naming_tableau10.jpg") ``` @@ -610,7 +610,7 @@ The columns on the right-hand side of the colors include symbols on which the us #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/overview_seq2.jpg") +knitr::include_graphics("../man/figures/overview_seq2.jpg") ``` @@ -619,7 +619,7 @@ knitr::include_graphics("../../man/figures/overview_seq2.jpg") #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/overview_div.jpg") +knitr::include_graphics("../man/figures/overview_div.jpg") ``` @@ -633,7 +633,7 @@ The properties fairness, hues, and vividness all use the HCL color space, and ar #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/hcl_carto_safe.jpg") +knitr::include_graphics("../man/figures/hcl_carto_safe.jpg") ``` @@ -653,7 +653,7 @@ Fairness and color blind friendliness often present conflicting objectives. Many #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/cols4all_fair_sort_cbf.jpg") +knitr::include_graphics("../man/figures/cols4all_fair_sort_cbf.jpg") ``` @@ -668,7 +668,7 @@ A severe issue that may induce visual bias for color blind people is illustrated #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/cols4all_matplotlib_spectral.jpg") +knitr::include_graphics("../man/figures/cols4all_matplotlib_spectral.jpg") ``` @@ -680,7 +680,7 @@ Several spectral sequential palettes from the series \texttt{scico} @scico, \tex #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/cols4all_seq_spectral.jpg") +knitr::include_graphics("../man/figures/cols4all_seq_spectral.jpg") ``` @@ -689,7 +689,7 @@ knitr::include_graphics("../../man/figures/cols4all_seq_spectral.jpg") #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/cols4all_div.jpg") +knitr::include_graphics("../man/figures/cols4all_div.jpg") ``` @@ -738,7 +738,7 @@ The used approach to find those palettes was the following: #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/c4a_pals.jpg") +knitr::include_graphics("../man/figures/c4a_pals.jpg") ``` @@ -748,7 +748,7 @@ knitr::include_graphics("../../man/figures/c4a_pals.jpg") #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/area7.jpg") +knitr::include_graphics("../man/figures/area7.jpg") ``` @@ -757,7 +757,7 @@ knitr::include_graphics("../../man/figures/area7.jpg") #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/area7d.jpg") +knitr::include_graphics("../man/figures/area7d.jpg") ``` @@ -766,7 +766,7 @@ knitr::include_graphics("../../man/figures/area7d.jpg") #| out.width = 350, #| echo = FALSE -knitr::include_graphics(c("../../man/figures/line7_wt.jpg", "../../man/figures/line7_bk.jpg")) +knitr::include_graphics(c("../man/figures/line7_wt.jpg", "../man/figures/line7_bk.jpg")) ``` @@ -775,7 +775,7 @@ knitr::include_graphics(c("../../man/figures/line7_wt.jpg", "../../man/figures/l #| out.width = 700, #| echo = FALSE -knitr::include_graphics("../../man/figures/friendly13.jpg") +knitr::include_graphics("../man/figures/friendly13.jpg") ```