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

Add reverse arg to hbar()

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

15
docs/reference/abort_bad_argument.html
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,21 +51,28 @@
<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">abort_bad_argument</span><span class="op">(</span><span class="va">arg</span>, <span class="va">must</span>, not <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">abort_bad_argument</span><span class="op">(</span><span class="va">arg</span>, <span class="va">must</span>, not <span class="op">=</span> <span class="cn">NULL</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>arg</dt>
<dd><p>An argument</p></dd>
<dt>must</dt>
<dd><p>What arg must be</p></dd>
<dt>not</dt>
<dd><p>Optional. What arg must not be.</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A stop statement</p>
<p>A stop statement</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -77,7 +84,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>

13
docs/reference/buffer_bbox.html
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,19 +51,24 @@
<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">buffer_bbox</span><span class="op">(</span><span class="va">sf_obj</span>, buffer <span class="op">=</span> <span class="fl">0</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">buffer_bbox</span><span class="op">(</span><span class="va">sf_obj</span>, buffer <span class="op">=</span> <span class="fl">0</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>sf_obj</dt>
<dd><p>A `sf` object</p></dd>
<dt>buffer</dt>
<dd><p>A buffer, either one value or a vector of 4 values (left, bottom, right, top). Default to 0.</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A bbox with a buffer</p>
<p>A bbox with a buffer</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -75,7 +80,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>

13
docs/reference/cols_agora.html
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,19 +51,24 @@
<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">cols_agora</span><span class="op">(</span><span class="va">...</span>, unnamed <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">cols_agora</span><span class="op">(</span><span class="va">...</span>, unnamed <span class="op">=</span> <span class="cn">TRUE</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>...</dt>
<dd><p>Character names of reach colors. If NULL returns all colors</p></dd>
<dt>unnamed</dt>
<dd><p>Should the output vector be unnamed? Default to `TRUE`</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>An hex code or hex codes named or unnamed</p>
<p>An hex code or hex codes named or unnamed</p>
</div>
<div class="section level2">
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
@ -79,7 +84,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>

13
docs/reference/cols_reach.html
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,19 +51,24 @@
<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">cols_reach</span><span class="op">(</span><span class="va">...</span>, unnamed <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">cols_reach</span><span class="op">(</span><span class="va">...</span>, unnamed <span class="op">=</span> <span class="cn">TRUE</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>...</dt>
<dd><p>Character names of reach colors. If NULL returns all colors</p></dd>
<dt>unnamed</dt>
<dd><p>Should the output vector be unnamed? Default to `TRUE`</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>An hex code or hex codes named or unnamed</p>
<p>An hex code or hex codes named or unnamed</p>
</div>
<div class="section level2">
<h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
@ -79,7 +84,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>

60
docs/reference/hbar.html
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</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</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>

60
docs/reference/hbar_percent.html
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>

17
docs/reference/if_not_in_stop.html
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,23 +51,32 @@
<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">if_not_in_stop</span><span class="op">(</span><span class="va">.tbl</span>, <span class="va">cols</span>, <span class="va">df</span>, arg <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">if_not_in_stop</span><span class="op">(</span><span class="va">.tbl</span>, <span class="va">cols</span>, <span class="va">df</span>, arg <span class="op">=</span> <span class="cn">NULL</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>A tibble</p></dd>
<dt>cols</dt>
<dd><p>A vector of column names (quoted)</p></dd>
<dt>df</dt>
<dd><p>Provide the tibble name as a character string</p></dd>
<dt>arg</dt>
<dd><p>Default to NULL.</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A stop statement</p>
<p>A stop statement</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -79,7 +88,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>

17
docs/reference/if_vec_not_in_stop.html
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,23 +51,32 @@
<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">if_vec_not_in_stop</span><span class="op">(</span><span class="va">vec</span>, <span class="va">cols</span>, <span class="va">vec_name</span>, arg <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">if_vec_not_in_stop</span><span class="op">(</span><span class="va">vec</span>, <span class="va">cols</span>, <span class="va">vec_name</span>, arg <span class="op">=</span> <span class="cn">NULL</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>vec</dt>
<dd><p>A vector of character strings</p></dd>
<dt>cols</dt>
<dd><p>A set of character strings</p></dd>
<dt>vec_name</dt>
<dd><p>Provide the vector name as a character string</p></dd>
<dt>arg</dt>
<dd><p>Default to NULL.</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A stop statement if some elements of vec are not in cols</p>
<p>A stop statement if some elements of vec are not in cols</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -79,7 +88,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>

4
docs/reference/index.html
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">
@ -148,7 +148,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>

31
docs/reference/pal_agora.html
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,31 +51,42 @@
<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">pal_agora</span><span class="op">(</span>
palette <span class="op">=</span> <span class="st">"main"</span>,
reverse <span class="op">=</span> <span class="cn">FALSE</span>,
color_ramp_palette <span class="op">=</span> <span class="cn">FALSE</span>,
show_palettes <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">pal_agora</span><span class="op">(</span></span>
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> color_ramp_palette <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> show_palettes <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>palette</dt>
<dd><p>Character name of a palette in AGORA palettes</p></dd>
<dt>reverse</dt>
<dd><p>Boolean indicating whether the palette should be reversed</p></dd>
<dt>color_ramp_palette</dt>
<dd><p>Should the output be a `grDevices::colorRampPalette` function or a vector of hex codes? Default to the former with `TRUE`</p></dd>
<dt>show_palettes</dt>
<dd><p>Should the ouput be the set of palettes names to pick from? Default to `FALSE`</p></dd>
<dt>...</dt>
<dd><p>Additional arguments to pass to colorRampPalette()</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A color palette</p>
<p>A color palette</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -87,7 +98,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>

31
docs/reference/pal_reach.html
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,31 +51,42 @@
<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">pal_reach</span><span class="op">(</span>
palette <span class="op">=</span> <span class="st">"main"</span>,
reverse <span class="op">=</span> <span class="cn">FALSE</span>,
color_ramp_palette <span class="op">=</span> <span class="cn">FALSE</span>,
show_palettes <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">pal_reach</span><span class="op">(</span></span>
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
<span> reverse <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> color_ramp_palette <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span> show_palettes <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>palette</dt>
<dd><p>Character name of a palette in REACH palettes</p></dd>
<dt>reverse</dt>
<dd><p>Boolean indicating whether the palette should be reversed</p></dd>
<dt>color_ramp_palette</dt>
<dd><p>Should the output be a `grDevices::colorRampPalette` function or a vector of hex codes? Default to the former with `TRUE`</p></dd>
<dt>show_palettes</dt>
<dd><p>Should the ouput be the set of palettes names to pick from? Default to `FALSE`</p></dd>
<dt>...</dt>
<dd><p>Additional arguments to pass to colorRampPalette()</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A color palette</p>
<p>A color palette</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -87,7 +98,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>

31
docs/reference/scale_color.html
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,32 +51,43 @@
<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">scale_color</span><span class="op">(</span>
initiative <span class="op">=</span> <span class="st">"reach"</span>,
palette <span class="op">=</span> <span class="st">"main"</span>,
discrete <span class="op">=</span> <span class="cn">TRUE</span>,
reverse <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">scale_color</span><span class="op">(</span></span>
<span> initiative <span class="op">=</span> <span class="st">"reach"</span>,</span>
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
<span> discrete <span class="op">=</span> <span class="cn">TRUE</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>initiative</dt>
<dd><p>Either "reach" or "agora</p></dd>
<dt>palette</dt>
<dd><p>Palette name from `pal_reach()` or `pal_agora()`</p></dd>
<dt>discrete</dt>
<dd><p>Boolean indicating whether color aesthetic is discrete or not</p></dd>
<dt>reverse</dt>
<dd><p>Boolean indicating whether the palette should be reversed</p></dd>
<dt>...</dt>
<dd><p>Additional arguments passed to discrete_scale() or
scale_color_gradient(), used respectively when discrete is TRUE or FALSE</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A color scale for ggplot</p>
<p>A color scale for ggplot</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -88,7 +99,7 @@ scale_color_gradient(), used respectively when discrete is TRUE or FALSE</p></dd
</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>

31
docs/reference/scale_fill.html
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,32 +51,43 @@
<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">scale_fill</span><span class="op">(</span>
initiative <span class="op">=</span> <span class="st">"reach"</span>,
palette <span class="op">=</span> <span class="st">"main"</span>,
discrete <span class="op">=</span> <span class="cn">TRUE</span>,
reverse <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">scale_fill</span><span class="op">(</span></span>
<span> initiative <span class="op">=</span> <span class="st">"reach"</span>,</span>
<span> palette <span class="op">=</span> <span class="st">"main"</span>,</span>
<span> discrete <span class="op">=</span> <span class="cn">TRUE</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>initiative</dt>
<dd><p>Either "reach" or "agora</p></dd>
<dt>palette</dt>
<dd><p>Palette name from `pal_reach()` or `pal_agora()`</p></dd>
<dt>discrete</dt>
<dd><p>Boolean indicating whether color aesthetic is discrete or not</p></dd>
<dt>reverse</dt>
<dd><p>Boolean indicating whether the palette should be reversed</p></dd>
<dt>...</dt>
<dd><p>Additional arguments passed to discrete_scale() or
scale_fill_gradient(), used respectively when discrete is TRUE or FALSE</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A fill scale for ggplot</p>
<p>A fill scale for ggplot</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -88,7 +99,7 @@ scale_fill_gradient(), used respectively when discrete is TRUE or FALSE</p></dd>
</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>

13
docs/reference/subvec_not_in.html
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,19 +51,24 @@
<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">subvec_not_in</span><span class="op">(</span><span class="va">vector</span>, <span class="va">set</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">subvec_not_in</span><span class="op">(</span><span class="va">vector</span>, <span class="va">set</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>vector</dt>
<dd><p>A vector to subset</p></dd>
<dt>set</dt>
<dd><p>A set-vector</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A subset of vector not in set</p>
<p>A subset of vector not in set</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -75,7 +80,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>

11
docs/reference/theme_reach.html
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,17 +51,20 @@
<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">theme_reach</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_reach</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</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>family</dt>
<dd><p>The font family. Default to "Leelawadee"</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>The base REACH theme</p>
<p>The base REACH theme</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -73,7 +76,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>

11
docs/reference/theme_reach_borders.html
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,17 +51,20 @@
<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">theme_reach_borders</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_reach_borders</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</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>family</dt>
<dd><p>The font family. Default to "Leelawadee"</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A theme to be added to the "+" ggplot grammar</p>
<p>A theme to be added to the "+" ggplot grammar</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -73,7 +76,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>

11
docs/reference/theme_reach_flip_hist.html
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,17 +51,20 @@
<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">theme_reach_flip_hist</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_reach_flip_hist</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</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>family</dt>
<dd><p>The font family. Default to "Leelawadee"</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A theme to be added to the "+" ggplot grammar</p>
<p>A theme to be added to the "+" ggplot grammar</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -73,7 +76,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>

11
docs/reference/theme_reach_hist.html
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,17 +51,20 @@
<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">theme_reach_hist</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</span><span class="op">)</span></code></pre></div>
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">theme_reach_hist</span><span class="op">(</span>family <span class="op">=</span> <span class="st">"Leelawadee"</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>family</dt>
<dd><p>The font family. Default to "Leelawadee"</p></dd>
</dl></div>
<div class="section level2">
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
<p>A theme to be added to the "+" ggplot grammar</p>
<p>A theme to be added to the "+" ggplot grammar</p>
</div>
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
@ -73,7 +76,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>