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

421 lines
41 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<title>What a color! What a viz! • visualizeR</title>
<!-- favicons --><link rel="icon" type="image/png" sizes="96x96" href="favicon-96x96.png">
<link rel="icon" type="”image/svg+xml”" href="favicon.svg">
<link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
<link rel="icon" sizes="any" href="favicon.ico">
<link rel="manifest" href="site.webmanifest">
<script src="deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link href="deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet">
<script src="deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet">
<link href="deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet">
<script src="deps/headroom-0.11.0/headroom.min.js"></script><script src="deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="deps/search-1.0.0/fuse.min.js"></script><script src="deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="pkgdown.js"></script><meta property="og:title" content="What a color! What a viz!">
<meta name="description" content="It basically provides colors as hex codes, color palettes, and some viz functions (graphs and maps).">
<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">
</head>
<body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">
<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="">1.0</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">
<span class="navbar-toggler-icon"></span>
</button>
<div id="navbar" class="collapse navbar-collapse ms-3">
<ul class="navbar-nav me-auto">
<li class="nav-item"><a class="nav-link" href="reference/index.html">Reference</a></li>
<li class="nav-item"><a class="nav-link" href="news/index.html">Changelog</a></li>
</ul>
<ul class="navbar-nav">
<li class="nav-item"><form class="form-inline" role="search">
<input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="search.json">
</form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/gnoblet/visualizeR/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
</ul>
</div>
</div>
</nav><div class="container template-home">
<div class="row">
<main id="main" class="col-md-9"><div class="section level1">
<div class="page-header">
<img src="logo.png" class="logo" alt=""><h1 id="visualizer-">visualizeR <a class="anchor" aria-label="anchor" href="#visualizer-"></a>
</h1>
</div>
<!-- badges: start -->
<blockquote>
<p>What a color! What a viz!</p>
</blockquote>
<p><code>visualizeR</code> proposes some utils to sane colors, ready-to-go color palettes, and a few visualization functions. The package is thoroughly tested with comprehensive code coverage.</p>
<div class="section level2">
<h2 id="installation">Installation<a class="anchor" aria-label="anchor" href="#installation"></a>
</h2>
<p>You can install the last version of visualizeR from <a href="https://github.com/" class="external-link">GitHub</a> with:</p>
<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="co"># install.packages("devtools")</span></span>
<span><span class="fu">devtools</span><span class="fu">::</span><span class="fu">install_github</span><span class="op">(</span><span class="st">"gnoblet/visualizeR"</span>, build_vignettes <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="roadmap">Roadmap<a class="anchor" aria-label="anchor" href="#roadmap"></a>
</h2>
<p>Roadmap is as follows:</p>
<ul class="task-list">
<li><label><input type="checkbox">Full revamp of core functions (colors, pattern, incl. adding test and pre-commit structures)</label></li>
<li><label><input type="checkbox" checked>Add test coverage reporting via codecov</label></li>
<li><label><input type="checkbox">Maintain &gt;80% test coverage across all functions</label></li>
<li>
<label><input type="checkbox">Add other types of plots:</label>
<ul class="task-list">
<li><label><input type="checkbox">Dumbell</label></li>
<li><label><input type="checkbox">Waffle</label></li>
<li><label><input type="checkbox">Donut</label></li>
<li><label><input type="checkbox">Alluvial</label></li>
</ul>
</li>
<li><label><input type="checkbox">Option for tag with css code + for titles/subtitles/captions</label></li>
</ul>
</div>
<div class="section level2">
<h2 id="request">Request<a class="anchor" aria-label="anchor" href="#request"></a>
</h2>
<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:gnoblet@zaclys.net" class="email">gnoblet@zaclys.net</a>).</p>
</div>
<div class="section level2">
<h2 id="code-coverage">Code Coverage<a class="anchor" aria-label="anchor" href="#code-coverage"></a>
</h2>
<p><code>visualizeR</code> uses <a href="https://codecov.io/" class="external-link">codecov</a> for test coverage reporting. You can see the current coverage status by clicking on the codecov badge at the top of this README. We aim to maintain high test coverage to ensure code reliability and stability.</p>
</div>
<div class="section level2">
<h2 id="colors">Colors<a class="anchor" aria-label="anchor" href="#colors"></a>
</h2>
<p>Functions to access colors and palettes are <code><a href="reference/color.html">color()</a></code> or <code><a href="reference/palette.html">palette()</a></code>. Feel free to pull request new 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 colors, named</span></span>
<span><span class="fu"><a href="reference/color.html">color</a></span><span class="op">(</span>unname <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 lighter_grey light_grey dark_grey light_blue_grey </span></span>
<span><span class="co">#&gt; "#FFFFFF" "#F5F5F5" "#E3E3E3" "#464647" "#B3C6D1" </span></span>
<span><span class="co">#&gt; grey black cat_2_yellow_1 cat_2_yellow_2 cat_2_light_1 </span></span>
<span><span class="co">#&gt; "#71716F" "#000000" "#ffc20a" "#0c7bdc" "#fefe62"</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/palette.html">palette</a></span><span class="op">(</span>palette <span class="op">=</span> <span class="st">"cat_5_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] "#083d77" "#4ecdc4" "#f4c095" "#b47eb3" "#ffd5ff"</span></span>
<span></span>
<span><span class="co"># Get all color palettes names</span></span>
<span><span class="fu"><a href="reference/palette.html">palette</a></span><span class="op">(</span>show_palettes <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
<span><span class="co">#&gt; [1] "cat_2_yellow" "cat_2_light" </span></span>
<span><span class="co">#&gt; [3] "cat_2_green" "cat_2_blue" </span></span>
<span><span class="co">#&gt; [5] "cat_5_main" "cat_5_ibm" </span></span>
<span><span class="co">#&gt; [7] "cat_3_aquamarine" "cat_3_tol_high_contrast"</span></span>
<span><span class="co">#&gt; [9] "cat_8_tol_adapted" "cat_3_custom_1" </span></span>
<span><span class="co">#&gt; [11] "cat_4_custom_1" "cat_5_custom_1" </span></span>
<span><span class="co">#&gt; [13] "cat_6_custom_1" "div_5_orange_blue" </span></span>
<span><span class="co">#&gt; [15] "div_5_green_purple"</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">Example 1: Bar chart<a class="anchor" aria-label="anchor" href="#example-1-bar-chart"></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://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>
<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="va">df_island</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="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>
<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 with some alpha transparency</span></span>
<span><span class="fu"><a href="reference/bar.html">bar</a></span><span class="op">(</span><span class="va">df</span>, <span class="st">"island"</span>, <span class="st">"mean_bl"</span>, <span class="st">"species"</span>, x_title <span class="op">=</span> <span class="st">"Mean of bill length"</span>, title <span class="op">=</span> <span class="st">"Mean of bill length by island and species"</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-bar-chart-1.png" width="65%"></p>
<div class="sourceCode" id="cb4"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Flipped / Horizontal</span></span>
<span><span class="fu"><a href="reference/bar.html">hbar</a></span><span class="op">(</span><span class="va">df</span>, <span class="st">"island"</span>, <span class="st">"mean_bl"</span>, <span class="st">"species"</span>, x_title <span class="op">=</span> <span class="st">"Mean of bill length"</span>, title <span class="op">=</span> <span class="st">"Mean of bill length by island and species"</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-bar-chart-2.png" width="65%"></p>
<div class="sourceCode" id="cb5"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Facetted</span></span>
<span><span class="fu"><a href="reference/bar.html">bar</a></span><span class="op">(</span><span class="va">df</span>, <span class="st">"island"</span>, <span class="st">"mean_bl"</span>, facet <span class="op">=</span> <span class="st">"species"</span>, x_title <span class="op">=</span> <span class="st">"Mean of bill length"</span>, title <span class="op">=</span> <span class="st">"Mean of bill length by island and species"</span>, add_color_guide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-bar-chart-3.png" width="65%"></p>
<div class="sourceCode" id="cb6"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Flipped, with text, smaller width, and caption</span></span>
<span><span class="fu"><a href="reference/bar.html">hbar</a></span><span class="op">(</span>df <span class="op">=</span> <span class="va">df_island</span>, x <span class="op">=</span> <span class="st">"island"</span>, y <span class="op">=</span> <span class="st">"mean_bl"</span>, title <span class="op">=</span> <span class="st">"Mean of bill length by island"</span>, add_text <span class="op">=</span> <span class="cn">T</span>, width <span class="op">=</span> <span class="fl">0.6</span>, add_text_suffix <span class="op">=</span> <span class="st">"mm"</span>, add_text_expand_limit <span class="op">=</span> <span class="fl">1.3</span>, add_color_guide <span class="op">=</span> <span class="cn">FALSE</span>, caption <span class="op">=</span> <span class="st">"Data: palmerpenguins package."</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-bar-chart-4.png" width="65%"></p>
</div>
<div class="section level3">
<h3 id="example-2-scatterplot">Example 2: Scatterplot<a class="anchor" aria-label="anchor" href="#example-2-scatterplot"></a>
</h3>
<div class="sourceCode" id="cb7"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="co"># Simple scatterplot</span></span>
<span><span class="fu"><a href="reference/point.html">point</a></span><span class="op">(</span><span class="va">penguins</span>, <span class="st">"bill_length_mm"</span>, <span class="st">"flipper_length_mm"</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-point-chart-1.png" width="65%"></p>
<div class="sourceCode" id="cb8"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Scatterplot with grouping colors, greater dot size, some transparency</span></span>
<span><span class="fu"><a href="reference/point.html">point</a></span><span class="op">(</span><span class="va">penguins</span>, <span class="st">"bill_length_mm"</span>, <span class="st">"flipper_length_mm"</span>, <span class="st">"island"</span>, group_title <span class="op">=</span> <span class="st">"Island"</span>, alpha <span class="op">=</span> <span class="fl">0.6</span>, size <span class="op">=</span> <span class="fl">3</span>, title <span class="op">=</span> <span class="st">"Bill vs. flipper length"</span>, , add_color_guide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-point-chart-2.png" width="65%"></p>
<div class="sourceCode" id="cb9"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Facetted scatterplot by island</span></span>
<span><span class="fu"><a href="reference/point.html">point</a></span><span class="op">(</span><span class="va">penguins</span>, <span class="st">"bill_length_mm"</span>, <span class="st">"flipper_length_mm"</span>, <span class="st">"species"</span>, <span class="st">"island"</span>, <span class="st">"fixed"</span>, group_title <span class="op">=</span> <span class="st">"Species"</span>, title <span class="op">=</span> <span class="st">"Bill vs. flipper length by species and island"</span>, add_color_guide <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-point-chart-3.png" width="65%"></p>
</div>
<div class="section level3">
<h3 id="example-3-dumbbell-plot">Example 3: Dumbbell plot<a class="anchor" aria-label="anchor" href="#example-3-dumbbell-plot"></a>
</h3>
<p>Remember to ensure that your data are in the long format and you only have two groups on the x-axis; for instance, IDP and returnee and no NA values.</p>
<div class="sourceCode" id="cb10"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="co"># Prepare long data</span></span>
<span><span class="va">df</span> <span class="op">&lt;-</span> <span class="fu">tibble</span><span class="fu">::</span><span class="fu"><a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a></span><span class="op">(</span></span>
<span> admin1 <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="va">letters</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">8</span><span class="op">]</span>, <span class="fl">2</span><span class="op">)</span>,</span>
<span> setting <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="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><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">"Rural"</span>, <span class="st">"Urban"</span><span class="op">)</span>, <span class="fl">4</span><span class="op">)</span>, <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><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">"Urban"</span>, <span class="st">"Rural"</span><span class="op">)</span>, <span class="fl">4</span><span class="op">)</span><span class="op">)</span>,</span>
<span> stat <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/stats/Normal.html" class="external-link">rnorm</a></span><span class="op">(</span><span class="fl">16</span>, mean <span class="op">=</span> <span class="fl">50</span>, sd <span class="op">=</span> <span class="fl">18</span><span class="op">)</span></span>
<span><span class="op">)</span> <span class="op">|&gt;</span></span>
<span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate.html" class="external-link">mutate</a></span><span class="op">(</span>stat <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="va">stat</span>, <span class="fl">0</span><span class="op">)</span><span class="op">)</span></span>
<span></span>
<span></span>
<span></span>
<span></span>
<span><span class="co"># dumbbell(</span></span>
<span><span class="co"># df,</span></span>
<span><span class="co"># 'stat',</span></span>
<span><span class="co"># 'setting',</span></span>
<span><span class="co"># 'admin1',</span></span>
<span><span class="co"># title = '% of HHs that reported open defecation as sanitation facility',</span></span>
<span><span class="co"># group_y_title = 'Admin 1',</span></span>
<span><span class="co"># group_x_title = 'Setting'</span></span>
<span><span class="co"># )</span></span></code></pre></div>
</div>
<div class="section level3">
<h3 id="example-4-donut-chart">Example 4: donut chart<a class="anchor" aria-label="anchor" href="#example-4-donut-chart"></a>
</h3>
<div class="sourceCode" id="cb11"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="co"># Some summarized data: % of HHs by displacement status</span></span>
<span><span class="va">df</span> <span class="op">&lt;-</span> <span class="fu">tibble</span><span class="fu">::</span><span class="fu"><a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a></span><span class="op">(</span></span>
<span> status <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">"Displaced"</span>, <span class="st">"Non displaced"</span>, <span class="st">"Returnee"</span>, <span class="st">"Don't know/Prefer not to say"</span><span class="op">)</span>,</span>
<span> percentage <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">18</span>, <span class="fl">65</span>, <span class="fl">12</span>, <span class="fl">3</span><span class="op">)</span></span>
<span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Donut</span></span>
<span><span class="co"># donut(df,</span></span>
<span><span class="co"># status,</span></span>
<span><span class="co"># percentage,</span></span>
<span><span class="co"># hole_size = 3,</span></span>
<span><span class="co"># add_text_suffix = '%',</span></span>
<span><span class="co"># add_text_color = color('dark_grey'),</span></span>
<span><span class="co"># add_text_treshold_display = 5,</span></span>
<span><span class="co"># x_title = 'Displacement status',</span></span>
<span><span class="co"># title = '% of HHs by displacement status'</span></span>
<span><span class="co"># )</span></span></code></pre></div>
</div>
<div class="section level3">
<h3 id="example-5-waffle-chart">Example 5: Waffle chart<a class="anchor" aria-label="anchor" href="#example-5-waffle-chart"></a>
</h3>
<div class="sourceCode" id="cb12"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="co">#</span></span>
<span><span class="co"># waffle(df, status, percentage, x_title = 'A caption', title = 'A title', subtitle = 'A subtitle')</span></span></code></pre></div>
</div>
<div class="section level3">
<h3 id="example-6-alluvial-chart">Example 6: Alluvial chart<a class="anchor" aria-label="anchor" href="#example-6-alluvial-chart"></a>
</h3>
<div class="sourceCode" id="cb13"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span><span class="co"># Some summarized data: % of HHs by self-reported status of displacement in 2021 and in 2022</span></span>
<span><span class="va">df</span> <span class="op">&lt;-</span> <span class="fu">tibble</span><span class="fu">::</span><span class="fu"><a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a></span><span class="op">(</span></span>
<span> status_from <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>
<span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="st">"Displaced"</span>, <span class="fl">4</span><span class="op">)</span>,</span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="st">"Non displaced"</span>, <span class="fl">4</span><span class="op">)</span>,</span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="st">"Returnee"</span>, <span class="fl">4</span><span class="op">)</span>,</span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><span class="op">(</span><span class="st">"Dnk/Pnts"</span>, <span class="fl">4</span><span class="op">)</span></span>
<span> <span class="op">)</span>,</span>
<span> status_to <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">"Displaced"</span>, <span class="st">"Non displaced"</span>, <span class="st">"Returnee"</span>, <span class="st">"Dnk/Pnts"</span>, <span class="st">"Displaced"</span>, <span class="st">"Non displaced"</span>, <span class="st">"Returnee"</span>, <span class="st">"Dnk/Pnts"</span>, <span class="st">"Displaced"</span>, <span class="st">"Non displaced"</span>, <span class="st">"Returnee"</span>, <span class="st">"Dnk/Pnts"</span>, <span class="st">"Displaced"</span>, <span class="st">"Non displaced"</span>, <span class="st">"Returnee"</span>, <span class="st">"Dnk/Pnts"</span><span class="op">)</span>,</span>
<span> percentage <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">20</span>, <span class="fl">8</span>, <span class="fl">18</span>, <span class="fl">1</span>, <span class="fl">12</span>, <span class="fl">21</span>, <span class="fl">0</span>, <span class="fl">2</span>, <span class="fl">0</span>, <span class="fl">3</span>, <span class="fl">12</span>, <span class="fl">1</span>, <span class="fl">0</span>, <span class="fl">0</span>, <span class="fl">1</span>, <span class="fl">1</span><span class="op">)</span></span>
<span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Alluvial, here the group is the status for 2021</span></span>
<span></span>
<span><span class="co"># alluvial(df,</span></span>
<span><span class="co"># status_from,</span></span>
<span><span class="co"># status_to,</span></span>
<span><span class="co"># percentage,</span></span>
<span><span class="co"># status_from,</span></span>
<span><span class="co"># from_levels = c("Displaced", "Non displaced", "Returnee", "Dnk/Pnts"),</span></span>
<span><span class="co"># alpha = 0.8,</span></span>
<span><span class="co"># group_title = "Status for 2021",</span></span>
<span><span class="co"># title = "% of HHs by self-reported status from 2021 to 2022"</span></span>
<span><span class="co"># )</span></span></code></pre></div>
</div>
<div class="section level3">
<h3 id="example-7-lollipop-chart">Example 7: Lollipop chart<a class="anchor" aria-label="anchor" href="#example-7-lollipop-chart"></a>
</h3>
<div class="sourceCode" id="cb14"><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://tidyr.tidyverse.org" class="external-link">tidyr</a></span><span class="op">)</span></span>
<span><span class="co"># Prepare long data</span></span>
<span><span class="va">df</span> <span class="op">&lt;-</span> <span class="fu">tibble</span><span class="fu">::</span><span class="fu"><a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a></span><span class="op">(</span></span>
<span> admin1 <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/lapply.html" class="external-link">replicate</a></span><span class="op">(</span><span class="fl">15</span>, <span class="fu"><a href="https://rdrr.io/r/base/sample.html" class="external-link">sample</a></span><span class="op">(</span><span class="va">letters</span>, <span class="fl">8</span><span class="op">)</span><span class="op">)</span> <span class="op">|&gt;</span> <span class="fu"><a href="https://rdrr.io/r/base/t.html" class="external-link">t</a></span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span> <span class="fu"><a href="https://rdrr.io/r/base/as.data.frame.html" class="external-link">as.data.frame</a></span><span class="op">(</span><span class="op">)</span> <span class="op">|&gt;</span> <span class="fu"><a href="https://tidyr.tidyverse.org/reference/unite.html" class="external-link">unite</a></span><span class="op">(</span><span class="st">"admin1"</span>, sep <span class="op">=</span> <span class="st">""</span><span class="op">)</span> <span class="op">|&gt;</span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/pull.html" class="external-link">pull</a></span><span class="op">(</span><span class="va">admin1</span><span class="op">)</span>,</span>
<span> stat <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/stats/Normal.html" class="external-link">rnorm</a></span><span class="op">(</span><span class="fl">15</span>, mean <span class="op">=</span> <span class="fl">50</span>, sd <span class="op">=</span> <span class="fl">15</span><span class="op">)</span></span>
<span><span class="op">)</span> <span class="op">|&gt;</span></span>
<span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate.html" class="external-link">mutate</a></span><span class="op">(</span>stat <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="va">stat</span>, <span class="fl">0</span><span class="op">)</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Simple vertical lollipop chart</span></span>
<span><span class="fu"><a href="reference/lollipop.html">lollipop</a></span><span class="op">(</span></span>
<span> df <span class="op">=</span> <span class="va">df</span>,</span>
<span> x <span class="op">=</span> <span class="st">"admin1"</span>,</span>
<span> y <span class="op">=</span> <span class="st">"stat"</span>,</span>
<span> flip <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> dot_size <span class="op">=</span> <span class="fl">3</span>,</span>
<span> y_title <span class="op">=</span> <span class="st">"% of HHs"</span>,</span>
<span> x_title <span class="op">=</span> <span class="st">"Admin 1"</span>,</span>
<span> title <span class="op">=</span> <span class="st">"% of HHs that received humanitarian assistance"</span></span>
<span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-lollipop-chart-1.png" width="65%"></p>
<div class="sourceCode" id="cb15"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Horizontal lollipop chart with custom colors</span></span>
<span><span class="fu"><a href="reference/lollipop.html">hlollipop</a></span><span class="op">(</span></span>
<span> df <span class="op">=</span> <span class="va">df</span>,</span>
<span> x <span class="op">=</span> <span class="st">"admin1"</span>,</span>
<span> y <span class="op">=</span> <span class="st">"stat"</span>,</span>
<span> dot_size <span class="op">=</span> <span class="fl">4</span>,</span>
<span> line_size <span class="op">=</span> <span class="fl">1</span>,</span>
<span> add_color <span class="op">=</span> <span class="fu"><a href="reference/color.html">color</a></span><span class="op">(</span><span class="st">"cat_5_main_2"</span><span class="op">)</span>,</span>
<span> line_color <span class="op">=</span> <span class="fu"><a href="reference/color.html">color</a></span><span class="op">(</span><span class="st">"cat_5_main_4"</span><span class="op">)</span>,</span>
<span> y_title <span class="op">=</span> <span class="st">"% of HHs"</span>,</span>
<span> x_title <span class="op">=</span> <span class="st">"Admin 1"</span>,</span>
<span> title <span class="op">=</span> <span class="st">"% of HHs that received humanitarian assistance"</span></span>
<span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-lollipop-chart-2.png" width="65%"></p>
<div class="sourceCode" id="cb16"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Create data for grouped lollipop - using set.seed for reproducibility</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/base/Random.html" class="external-link">set.seed</a></span><span class="op">(</span><span class="fl">123</span><span class="op">)</span></span>
<span><span class="va">df_grouped</span> <span class="op">&lt;-</span> <span class="fu">tibble</span><span class="fu">::</span><span class="fu"><a href="https://tibble.tidyverse.org/reference/tibble.html" class="external-link">tibble</a></span><span class="op">(</span></span>
<span> admin1 <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><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">"A"</span>, <span class="st">"B"</span>, <span class="st">"C"</span>, <span class="st">"D"</span>, <span class="st">"E"</span>, <span class="st">"F"</span><span class="op">)</span>, <span class="fl">2</span><span class="op">)</span>,</span>
<span> group <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/rep.html" class="external-link">rep</a></span><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">"Group A"</span>, <span class="st">"Group B"</span><span class="op">)</span>, each <span class="op">=</span> <span class="fl">6</span><span class="op">)</span>,</span>
<span> stat <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="fu"><a href="https://rdrr.io/r/stats/Normal.html" class="external-link">rnorm</a></span><span class="op">(</span><span class="fl">6</span>, mean <span class="op">=</span> <span class="fl">40</span>, sd <span class="op">=</span> <span class="fl">10</span><span class="op">)</span>, <span class="fu"><a href="https://rdrr.io/r/stats/Normal.html" class="external-link">rnorm</a></span><span class="op">(</span><span class="fl">6</span>, mean <span class="op">=</span> <span class="fl">60</span>, sd <span class="op">=</span> <span class="fl">10</span><span class="op">)</span><span class="op">)</span></span>
<span><span class="op">)</span> <span class="op">|&gt;</span></span>
<span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu"><a href="https://dplyr.tidyverse.org/reference/mutate.html" class="external-link">mutate</a></span><span class="op">(</span>stat <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="va">stat</span>, <span class="fl">0</span><span class="op">)</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># Grouped lollipop chart with proper side-by-side positioning</span></span>
<span><span class="fu"><a href="reference/lollipop.html">lollipop</a></span><span class="op">(</span></span>
<span> df <span class="op">=</span> <span class="va">df_grouped</span>,</span>
<span> x <span class="op">=</span> <span class="st">"admin1"</span>,</span>
<span> y <span class="op">=</span> <span class="st">"stat"</span>,</span>
<span> group <span class="op">=</span> <span class="st">"group"</span>,</span>
<span> order <span class="op">=</span> <span class="st">"grouped_y"</span>,</span>
<span> dot_size <span class="op">=</span> <span class="fl">3.5</span>,</span>
<span> line_size <span class="op">=</span> <span class="fl">0.8</span>,</span>
<span> y_title <span class="op">=</span> <span class="st">"Value"</span>,</span>
<span> x_title <span class="op">=</span> <span class="st">"Category"</span>,</span>
<span> title <span class="op">=</span> <span class="st">"True side-by-side grouped lollipop chart"</span></span>
<span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-lollipop-chart-3.png" width="65%"></p>
<div class="sourceCode" id="cb17"><pre class="downlit sourceCode r">
<code class="sourceCode R"><span></span>
<span><span class="co"># Horizontal grouped lollipop chart</span></span>
<span><span class="fu"><a href="reference/lollipop.html">hlollipop</a></span><span class="op">(</span></span>
<span> df <span class="op">=</span> <span class="va">df_grouped</span>,</span>
<span> x <span class="op">=</span> <span class="st">"admin1"</span>,</span>
<span> y <span class="op">=</span> <span class="st">"stat"</span>,</span>
<span> group <span class="op">=</span> <span class="st">"group"</span>,</span>
<span> dot_size <span class="op">=</span> <span class="fl">3.5</span>,</span>
<span> line_size <span class="op">=</span> <span class="fl">0.8</span>,</span>
<span> y_title <span class="op">=</span> <span class="st">"Category"</span>,</span>
<span> x_title <span class="op">=</span> <span class="st">"Value"</span>,</span>
<span> title <span class="op">=</span> <span class="st">"Horizontal side-by-side grouped lollipop chart"</span></span>
<span><span class="op">)</span></span></code></pre></div>
<p><img src="reference/figures/README-example-lollipop-chart-4.png" width="65%"></p>
</div>
</div>
</div>
</main><aside class="col-md-3"><div class="links">
<h2 data-toc-skip>Links</h2>
<ul class="list-unstyled">
<li><a href="https://github.com/gnoblet/visualizeR/" class="external-link">Browse source code</a></li>
</ul>
</div>
<div class="license">
<h2 data-toc-skip>License</h2>
<ul class="list-unstyled">
<li><a href="LICENSE.html">Full license</a></li>
<li><small>GPL (&gt;= 3)</small></li>
</ul>
</div>
<div class="citation">
<h2 data-toc-skip>Citation</h2>
<ul class="list-unstyled">
<li><a href="authors.html#citation">Citing visualizeR</a></li>
</ul>
</div>
<div class="developers">
<h2 data-toc-skip>Developers</h2>
<ul class="list-unstyled">
<li>Noblet Guillaume <br><small class="roles"> Author, maintainer </small> </li>
</ul>
</div>
<div class="dev-status">
<h2 data-toc-skip>Dev status</h2>
<ul class="list-unstyled">
<li><a href="https://github.com/gnoblet/visualizeR/actions/workflows/R-CMD-check.yml" class="external-link"><img src="https://github.com/gnoblet/visualizeR/actions/workflows/R-CMD-check.yml/badge.svg" alt="R-CMD-check"></a></li>
<li><a href="https://app.codecov.io/gh/gnoblet/visualizeR?branch=main" class="external-link"><img src="https://codecov.io/gh/gnoblet/visualizeR/branch/main/graph/badge.svg" alt="Codecov test coverage"></a></li>
</ul>
</div>
</aside>
</div>
<footer><div class="pkgdown-footer-left">
<p>Developed by Noblet Guillaume.</p>
</div>
<div class="pkgdown-footer-right">
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.3.</p>
</div>
</footer>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink