gnoblet/visualizeR
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update to v0.3.9000

Browse source
This commit is contained in:
gnoblet 2022-12-16 11:20:41 -05:00
parent 5e08875bea
commit 6af6fc044a
103 changed files with 3175 additions and 124 deletions
Download patch file Download diff file Expand all files Collapse all files

113
docs/index.html
View file

@ -17,7 +17,7 @@
<link href="deps/bootstrap-5.1.3/bootstrap.min.css" rel="stylesheet">
<script src="deps/bootstrap-5.1.3/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous">
<!-- bootstrap-toc --><script src="https://cdn.rawgit.com/afeld/bootstrap-toc/v1.0.1/dist/bootstrap-toc.min.js"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="pkgdown.js"></script><meta property="og:title" content="What a color! What a viz!">
<!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="pkgdown.js"></script><meta property="og:title" content="What a color! What a viz!">
<meta property="og:description" content="It basically provides colors as hex codes, color palettes, and some viz functions (graphs and maps).">
<meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png">
<!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
@ -33,7 +33,7 @@
<a class="navbar-brand me-2" href="index.html">visualizeR</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.2.9000</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.3.9000</small>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
@ -111,12 +111,115 @@
<p>Please, do not hesitate to pull request any new viz or colors or color palettes, or to email request any change (<a href="mailto:guillaume.noblet@reach-initiative.org" class="email">guillaume.noblet@reach-initiative.org</a> or <a href="mailto:gnoblet@zaclys.net" class="email">gnoblet@zaclys.net</a>).</p>
</div>
<div class="section level2">
<h2 id="example">Example<a class="anchor" aria-label="anchor" href="#example"></a>
<h2 id="colors">Colors<a class="anchor" aria-label="anchor" href="#colors"></a>
</h2>
<p>Color palettes for REACH, AGORA and IMPACT are available. Functions to access colors and palettes are <code>cols_initiative()</code> or <code>pal_initiative()</code>. For now, the initiative with the most colors and color palettes is REACH. Feel free to pull requests new AGORA and IMPACT colors.</p>
<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/gnoblet/visualizeR" class="external-link">visualizeR</a></span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Get all saved REACH colors, named</span></span>
<span><span class="fu"><a href="reference/cols_reach.html">cols_reach</a></span><span class="op">(</span>unnamed <span class="op">=</span> <span class="cn">F</span><span class="op">)</span></span></code></pre></div>
<span><span class="fu"><a href="reference/cols_reach.html">cols_reach</a></span><span class="op">(</span>unnamed <span class="op">=</span> <span class="cn">F</span><span class="op">)</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">10</span><span class="op">]</span></span>
<span><span class="co">#&gt; white black main_grey main_red main_lt_grey main_beige </span></span>
<span><span class="co">#&gt; "#FFFFFF" "#000000" "#58585A" "#EE5859" "#C7C8CA" "#D2CBB8" </span></span>
<span><span class="co">#&gt; iroise_1 iroise_2 iroise_3 iroise_4 </span></span>
<span><span class="co">#&gt; "#DFECEF" "#B1D7E0" "#699DA3" "#236A7A"</span></span>
<span></span>
<span><span class="co"># Extract a color palette as hexadecimal codes and reversed</span></span>
<span><span class="fu"><a href="reference/pal_reach.html">pal_reach</a></span><span class="op">(</span>palette <span class="op">=</span> <span class="st">"main"</span>, reversed <span class="op">=</span> <span class="cn">TRUE</span>, color_ramp_palette <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span>
<span><span class="co">#&gt; [1] "#58585A" "#EE5859" "#C7C8CA" "#D2CBB8"</span></span>
<span></span>
<span><span class="co"># Get all color palettes names</span></span>
<span><span class="fu"><a href="reference/pal_reach.html">pal_reach</a></span><span class="op">(</span>show_palettes <span class="op">=</span> <span class="cn">T</span><span class="op">)</span></span>
<span><span class="co">#&gt; [1] "main" "primary" "secondary" "two_dots" </span></span>
<span><span class="co">#&gt; [5] "two_dots_flashy" "red_main" "red_main_5" "red_alt" </span></span>
<span><span class="co">#&gt; [9] "red_alt_5" "iroise" "iroise_5" "discrete_6" </span></span>
<span><span class="co">#&gt; [13] "red_2" "red_3" "red_4" "red_5" </span></span>
<span><span class="co">#&gt; [17] "red_6" "red_7" "green_2" "green_3" </span></span>
<span><span class="co">#&gt; [21] "green_4" "green_5" "green_6" "green_7" </span></span>
<span><span class="co">#&gt; [25] "artichoke_2" "artichoke_3" "artichoke_4" "artichoke_5" </span></span>
<span><span class="co">#&gt; [29] "artichoke_6" "artichoke_7" "blue_2" "blue_3" </span></span>
<span><span class="co">#&gt; [33] "blue_4" "blue_5" "blue_6" "blue_7"</span></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="charts">Charts<a class="anchor" aria-label="anchor" href="#charts"></a>
</h2>
<div class="section level3">
<h3 id="example-1-bar-chart-already-reach-themed">Example 1: Bar chart, already REACH themed<a class="anchor" aria-label="anchor" href="#example-1-bar-chart-already-reach-themed"></a>
</h3>
<div class="sourceCode" id="cb3"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://github.com/gnoblet/visualizeR" class="external-link">visualizeR</a></span><span class="op">)</span></span>
<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://allisonhorst.github.io/palmerpenguins/" class="external-link">palmerpenguins</a></span><span class="op">)</span></span>
<span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://dplyr.tidyverse.org" class="external-link">dplyr</a></span><span class="op">)</span></span>
<span></span>
<span><span class="va">df</span> <span class="op">&lt;-</span> <span class="va">penguins</span> <span class="op">|&gt;</span> </span>
<span> <span class="fu"><a href="https://dplyr.tidyverse.org/reference/group_by.html" class="external-link">group_by</a></span><span class="op">(</span><span class="va">island</span>, <span class="va">species</span><span class="op">)</span> <span class="op">|&gt;</span> </span>
<span> <span class="fu"><a href="https://dplyr.tidyverse.org/reference/summarise.html" class="external-link">summarize</a></span><span class="op">(</span></span>
<span> mean_bl <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mean.html" class="external-link">mean</a></span><span class="op">(</span><span class="va">bill_length_mm</span>, na.rm <span class="op">=</span> <span class="cn">T</span><span class="op">)</span>,</span>
<span> mean_fl <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/mean.html" class="external-link">mean</a></span><span class="op">(</span><span class="va">flipper_length_mm</span>, na.rm <span class="op">=</span> <span class="cn">T</span><span class="op">)</span><span class="op">)</span> <span class="op">|&gt;</span> </span>
<span> <span class="fu"><a href="https://dplyr.tidyverse.org/reference/group_by.html" class="external-link">ungroup</a></span><span class="op">(</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Simple bar chart by group</span></span>
<span><span class="fu"><a href="reference/bar_reach.html">bar_reach</a></span><span class="op">(</span><span class="va">df</span>, <span class="va">mean_bl</span>, <span class="va">island</span>, <span class="va">species</span>, percent <span class="op">=</span> <span class="cn">FALSE</span>, x_title <span class="op">=</span> <span class="st">"Mean of bill length"</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-bar-chart-1.png" width="100%"></p>
<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Using another color palette</span></span>
<span><span class="fu"><a href="reference/bar_reach.html">bar_reach</a></span><span class="op">(</span><span class="va">df</span>, <span class="va">mean_bl</span>, <span class="va">island</span>, <span class="va">species</span>, percent <span class="op">=</span> <span class="cn">FALSE</span>, palette <span class="op">=</span> <span class="st">"artichoke_3"</span>, legend_rev <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-bar-chart-2.png" width="100%"></p>
</div>
<div class="section level3">
<h3 id="example-2-point-chart-already-reach-themed">Example 2: Point chart, already REACH themed<a class="anchor" aria-label="anchor" href="#example-2-point-chart-already-reach-themed"></a>
</h3>
<p>At this stage, <code><a href="reference/point_reach.html">point_reach()</a></code> only supports categorical grouping colors with the <code>group</code> arg.</p>
<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Simple point chart</span></span>
<span><span class="fu"><a href="reference/point_reach.html">point_reach</a></span><span class="op">(</span><span class="va">penguins</span>, <span class="va">bill_length_mm</span>, <span class="va">flipper_length_mm</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-point-chart-1.png" width="100%"></p>
<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Point chart with grouping colors, greater dot size, some transparency, reversed color palette</span></span>
<span><span class="fu"><a href="reference/point_reach.html">point_reach</a></span><span class="op">(</span><span class="va">penguins</span>, <span class="va">bill_length_mm</span>, <span class="va">flipper_length_mm</span>, <span class="va">island</span>, alpha <span class="op">=</span> <span class="fl">0.6</span>, size <span class="op">=</span> <span class="fl">3</span>, reverse <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-point-chart-2.png" width="100%"></p>
<div class="sourceCode" id="cb7"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Using another color palettes</span></span>
<span><span class="fu"><a href="reference/point_reach.html">point_reach</a></span><span class="op">(</span><span class="va">penguins</span>, <span class="va">bill_length_mm</span>, <span class="va">flipper_length_mm</span>, <span class="va">island</span>, palette <span class="op">=</span> <span class="st">"artichoke_3"</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-point-chart-3.png" width="100%"></p>
</div>
</div>
<div class="section level2">
<h2 id="maps">Maps<a class="anchor" aria-label="anchor" href="#maps"></a>
</h2>
<div class="sourceCode" id="cb8"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Add indicator layer </span></span>
<span><span class="co"># - based on "pretty" classes and title "Proportion (%)" </span></span>
<span><span class="co"># - buffer to add a 10% around the bounding box</span></span>
<span><span class="va">map</span> <span class="op">&lt;-</span> <span class="fu"><a href="reference/add_indicator_layer.html">add_indicator_layer</a></span><span class="op">(</span></span>
<span> <span class="va">indicator_admin1</span>, </span>
<span> <span class="va">opn_dfc</span>,</span>
<span> buffer <span class="op">=</span> <span class="fl">0.1</span><span class="op">)</span> <span class="op">+</span> </span>
<span> <span class="co"># Layout - some defaults - add the map title</span></span>
<span> <span class="fu"><a href="reference/add_layout.html">add_layout</a></span><span class="op">(</span><span class="st">"% of HH that reported open defecation as sanitation facility"</span><span class="op">)</span> <span class="op">+</span> </span>
<span> <span class="co"># Admin boundaries as list of shape files (lines) and colors, line widths and labels as vectors</span></span>
<span> <span class="fu"><a href="reference/add_admin_boundaries.html">add_admin_boundaries</a></span><span class="op">(</span></span>
<span> lines <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="va">line_admin1</span>, <span class="va">border_admin0</span>, <span class="va">frontier_admin0</span><span class="op">)</span>,</span>
<span> colors <span class="op">=</span> <span class="fu"><a href="reference/cols_reach.html">cols_reach</a></span><span class="op">(</span><span class="st">"main_lt_grey"</span>, <span class="st">"dk_grey"</span>, <span class="st">"black"</span><span class="op">)</span>,</span>
<span> lwds <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">0.5</span>, <span class="fl">2</span>, <span class="fl">3</span><span class="op">)</span>,</span>
<span> labels <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"Department"</span>, <span class="st">"Country"</span>, <span class="st">"Dominican Rep. frontier"</span><span class="op">)</span>,</span>
<span> title <span class="op">=</span> <span class="st">"Administrative boundaries"</span><span class="op">)</span> <span class="op">+</span> </span>
<span> <span class="co"># Add text labels - centered on admin 1 centroids</span></span>
<span> <span class="fu"><a href="reference/add_admin_labels.html">add_admin_labels</a></span><span class="op">(</span><span class="va">centroid_admin1</span>, <span class="va">ADM1_FR_UPPER</span><span class="op">)</span> <span class="op">+</span></span>
<span> <span class="co"># Add a compass</span></span>
<span> <span class="fu"><a href="reference/add_compass.html">add_compass</a></span><span class="op">(</span><span class="op">)</span> <span class="op">+</span></span>
<span> <span class="co"># Add a scale bar</span></span>
<span> <span class="fu"><a href="reference/add_scale_bar.html">add_scale_bar</a></span><span class="op">(</span><span class="op">)</span> <span class="op">+</span></span>
<span> <span class="co"># Add credits</span></span>
<span> <span class="fu"><a href="reference/add_credits.html">add_credits</a></span><span class="op">(</span><span class="st">"Admin. boundaries. : CNIGS \nCoord. system: GCS WGS 1984"</span><span class="op">)</span></span></code></pre></div>
<div class="figure">
<img src="reference/figures/README-example-map.png" alt=""><p class="caption">Once exported with <code><a href="https://rdrr.io/pkg/tmap/man/tmap_save.html" class="external-link">tmap::tmap_save()</a></code>.</p>
</div>
</div>
</div>
</main><aside class="col-md-3"><div class="links">
@ -162,7 +265,7 @@
<div class="pkgdown-footer-right">
<p></p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.7.</p>
</div>
</footer>