Add reverse arg to hbar()

This commit is contained in:
gnoblet 2022-07-06 20:14:37 -04:00
parent 956ffb2bdc
commit 15ab2819c7
31 changed files with 321 additions and 145 deletions

View file

@ -10,7 +10,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.1.3.9000</small>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.1.4.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">
@ -51,49 +51,77 @@
<div class="section level2">
<h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">hbar_percent</span><span class="op">(</span>
<span class="va">.tbl</span>,
<span class="va">x</span>,
<span class="va">y</span>,
group <span class="op">=</span> <span class="cn">NULL</span>,
initiative <span class="op">=</span> <span class="st">"reach"</span>,
x_title <span class="op">=</span> <span class="st">""</span>,
y_title <span class="op">=</span> <span class="st">""</span>,
group_title <span class="op">=</span> <span class="cn">NULL</span>,
font_family <span class="op">=</span> <span class="st">"Leelawadee"</span>,
stack <span class="op">=</span> <span class="cn">FALSE</span>,
<span class="va">...</span>
<span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">hbar_percent</span><span class="op">(</span></span>
<span> <span class="va">.tbl</span>,</span>
<span> <span class="va">x</span>,</span>
<span> <span class="va">y</span>,</span>
<span> group <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> initiative <span class="op">=</span> <span class="st">"reach"</span>,</span>
<span> x_title <span class="op">=</span> <span class="st">""</span>,</span>
<span> y_title <span class="op">=</span> <span class="st">""</span>,</span>
<span> group_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> font_family <span class="op">=</span> <span class="st">"Leelawadee"</span>,</span>
<span> stack <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div class="section level2">
<h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
<dl><dt>.tbl</dt>
<dd><p>Some data</p></dd>
<dt>x</dt>
<dd><p>Some numeric column on the x scale</p></dd>
<dt>y</dt>
<dd><p>Some column on the y scale</p></dd>
<dt>group</dt>
<dd><p>Some grouping categorical column, e.g. administrative areas</p></dd>
<dt>initiative</dt>
<dd><p>Either "reach" or "agora" or "impact" for the color palette</p></dd>
<dt>x_title</dt>
<dd><p>The x scale title. Default to empty string</p></dd>
<dt>y_title</dt>
<dd><p>The y scale title. Default to empty string</p></dd>
<dt>group_title</dt>
<dd><p>The group legend title. Defaut to NULL</p></dd>
<dt>font_family</dt>
<dd><p>The font family. Default to "Leelawadee"</p></dd>
<dt>stack</dt>
<dd><p>Should the chart be stacked? Default to "FALSE" (dodge)</p></dd>
<dt>reverse</dt>
<dd><p>Boolean indicating whether the color palette should be reversed</p></dd>
<dt>...</dt>
<dd><p>Other arguments to be passed to "simplevis::gg_hbar" or "simplevis:gg_hbar_col"</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A horizontal bar chart</p>
<p>A horizontal bar chart</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -105,7 +133,7 @@
</div>
<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.3.</p>
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.5.</p>
</div>
</footer></div>