FreesearchR/reference/sankey_ready.html

128 lines
22 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. 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>Readying data for sankey plot — sankey_ready • freesearcheR</title><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/Montserrat-0.4.9/font.css" rel="stylesheet"><link href="../deps/Public_Sans-0.4.9/font.css" rel="stylesheet"><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><link href="../extra.css" rel="stylesheet"><meta property="og:title" content="Readying data for sankey plot — sankey_ready"><meta name="description" content="Readying data for sankey plot"><meta property="og:description" content="Readying data for sankey plot"></head><body>
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
<nav class="navbar navbar-expand-lg fixed-top bg-primary" data-bs-theme="dark" aria-label="Site navigation"><div class="container">
<a class="navbar-brand me-2" href="../index.html">freesearcheR</a>
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">25.2.1</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="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item"><a class="nav-link" href="../ROADMAP.html">Roadmap</a></li>
<li class="nav-item"><a class="nav-link" href="../QA.html">Q&amp;A</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/agdamsbo/freesearcheR/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
</ul></div>
</div>
</nav><div class="container template-reference-topic">
<div class="row">
<main id="main" class="col-md-9"><div class="page-header">
<h1>Readying data for sankey plot</h1>
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/freesearcheR/blob/main/R/data_plots.R" class="external-link"><code>R/data_plots.R</code></a></small>
<div class="d-none name"><code>sankey_ready.Rd</code></div>
</div>
<div class="ref-description section level2">
<p>Readying data for sankey plot</p>
</div>
<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><span class="fu">sankey_ready</span><span class="op">(</span><span class="va">data</span>, <span class="va">x</span>, <span class="va">y</span>, z <span class="op">=</span> <span class="cn">NULL</span>, numbers <span class="op">=</span> <span class="st">"count"</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 id="arg-z">z<a class="anchor" aria-label="anchor" href="#arg-z"></a></dt>
<dd></dd>
</dl></div>
<div class="section level2">
<h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">ds</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/data.frame.html" class="external-link">data.frame</a></span><span class="op">(</span>g <span class="op">=</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="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">2</span><span class="op">]</span>, <span class="fl">100</span>, <span class="cn">TRUE</span><span class="op">)</span>, first <span class="op">=</span> <span class="fu">REDCapCAST</span><span class="fu">::</span><span class="fu">as_factor</span><span class="op">(</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="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">4</span><span class="op">]</span>, <span class="fl">100</span>, <span class="cn">TRUE</span><span class="op">)</span><span class="op">)</span>, last <span class="op">=</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="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</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">4</span><span class="op">]</span>, <span class="cn">NA</span><span class="op">)</span>, <span class="fl">100</span>, <span class="cn">TRUE</span>, prob <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="fl">.23</span>, <span class="fl">4</span><span class="op">)</span>, <span class="fl">.08</span><span class="op">)</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="va">ds</span> <span class="op">|&gt;</span> <span class="fu">sankey_ready</span><span class="op">(</span><span class="st">"first"</span>, <span class="st">"last"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># A tibble: 20 × 7</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> first last n gx.sum gy.sum lx ly </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;int&gt;</span> <span style="color: #949494; font-style: italic;">&lt;int&gt;</span> <span style="color: #949494; font-style: italic;">&lt;int&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 1</span> d a 5 22 17 <span style="color: #949494;">"</span>d\n(n=22)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>a\n(n=17)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 2</span> d b 8 22 25 <span style="color: #949494;">"</span>d\n(n=22)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>b\n(n=25)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 3</span> d c 4 22 29 <span style="color: #949494;">"</span>d\n(n=22)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>c\n(n=29)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 4</span> d d 4 22 22 <span style="color: #949494;">"</span>d\n(n=22)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>d\n(n=22)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 5</span> d <span style="color: #BB0000;">NA</span> 1 22 7 <span style="color: #949494;">"</span>d\n(n=22)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>NA\n(n=7)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 6</span> b a 1 32 17 <span style="color: #949494;">"</span>b\n(n=32)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>a\n(n=17)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 7</span> b b 11 32 25 <span style="color: #949494;">"</span>b\n(n=32)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>b\n(n=25)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 8</span> b c 12 32 29 <span style="color: #949494;">"</span>b\n(n=32)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>c\n(n=29)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 9</span> b d 7 32 22 <span style="color: #949494;">"</span>b\n(n=32)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>d\n(n=22)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">10</span> b <span style="color: #BB0000;">NA</span> 1 32 7 <span style="color: #949494;">"</span>b\n(n=32)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>NA\n(n=7)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">11</span> a a 8 23 17 <span style="color: #949494;">"</span>a\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>a\n(n=17)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">12</span> a b 2 23 25 <span style="color: #949494;">"</span>a\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>b\n(n=25)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">13</span> a c 7 23 29 <span style="color: #949494;">"</span>a\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>c\n(n=29)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">14</span> a d 4 23 22 <span style="color: #949494;">"</span>a\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>d\n(n=22)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">15</span> a <span style="color: #BB0000;">NA</span> 2 23 7 <span style="color: #949494;">"</span>a\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>NA\n(n=7)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">16</span> c a 3 23 17 <span style="color: #949494;">"</span>c\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>a\n(n=17)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">17</span> c b 4 23 25 <span style="color: #949494;">"</span>c\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>b\n(n=25)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">18</span> c c 6 23 29 <span style="color: #949494;">"</span>c\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>c\n(n=29)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">19</span> c d 7 23 22 <span style="color: #949494;">"</span>c\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>d\n(n=22)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">20</span> c <span style="color: #BB0000;">NA</span> 3 23 7 <span style="color: #949494;">"</span>c\n(n=23)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>NA\n(n=7)<span style="color: #949494;">"</span></span>
<span class="r-in"><span><span class="va">ds</span> <span class="op">|&gt;</span> <span class="fu">sankey_ready</span><span class="op">(</span><span class="st">"first"</span>, <span class="st">"last"</span>, numbers <span class="op">=</span> <span class="st">"percentage"</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494;"># A tibble: 20 × 7</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> first last n gx.sum gy.sum lx ly </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> <span style="color: #949494; font-style: italic;">&lt;chr&gt;</span> <span style="color: #949494; font-style: italic;">&lt;int&gt;</span> <span style="color: #949494; font-style: italic;">&lt;int&gt;</span> <span style="color: #949494; font-style: italic;">&lt;int&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> <span style="color: #949494; font-style: italic;">&lt;fct&gt;</span> </span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 1</span> d a 5 22 17 <span style="color: #949494;">"</span>d\n(22%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>a\n(17%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 2</span> d b 8 22 25 <span style="color: #949494;">"</span>d\n(22%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>b\n(25%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 3</span> d c 4 22 29 <span style="color: #949494;">"</span>d\n(22%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>c\n(29%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 4</span> d d 4 22 22 <span style="color: #949494;">"</span>d\n(22%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>d\n(22%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 5</span> d <span style="color: #BB0000;">NA</span> 1 22 7 <span style="color: #949494;">"</span>d\n(22%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>NA\n(7%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 6</span> b a 1 32 17 <span style="color: #949494;">"</span>b\n(32%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>a\n(17%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 7</span> b b 11 32 25 <span style="color: #949494;">"</span>b\n(32%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>b\n(25%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 8</span> b c 12 32 29 <span style="color: #949494;">"</span>b\n(32%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>c\n(29%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;"> 9</span> b d 7 32 22 <span style="color: #949494;">"</span>b\n(32%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>d\n(22%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">10</span> b <span style="color: #BB0000;">NA</span> 1 32 7 <span style="color: #949494;">"</span>b\n(32%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>NA\n(7%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">11</span> a a 8 23 17 <span style="color: #949494;">"</span>a\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>a\n(17%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">12</span> a b 2 23 25 <span style="color: #949494;">"</span>a\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>b\n(25%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">13</span> a c 7 23 29 <span style="color: #949494;">"</span>a\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>c\n(29%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">14</span> a d 4 23 22 <span style="color: #949494;">"</span>a\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>d\n(22%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">15</span> a <span style="color: #BB0000;">NA</span> 2 23 7 <span style="color: #949494;">"</span>a\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>NA\n(7%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">16</span> c a 3 23 17 <span style="color: #949494;">"</span>c\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>a\n(17%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">17</span> c b 4 23 25 <span style="color: #949494;">"</span>c\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>b\n(25%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">18</span> c c 6 23 29 <span style="color: #949494;">"</span>c\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>c\n(29%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">19</span> c d 7 23 22 <span style="color: #949494;">"</span>c\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>d\n(22%)<span style="color: #949494;">"</span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> <span style="color: #BCBCBC;">20</span> c <span style="color: #BB0000;">NA</span> 3 23 7 <span style="color: #949494;">"</span>c\n(23%)<span style="color: #949494;">"</span> <span style="color: #949494;">"</span>NA\n(7%)<span style="color: #949494;">"</span></span>
</code></pre></div>
</div>
</main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
</nav></aside></div>
<footer><div class="pkgdown-footer-left">
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
</div>
<div class="pkgdown-footer-right">
<p>Developed by Andreas Gammelgaard Damsbo. Provided without <strong>any warranty</strong>.</p>
</div>
</footer></div>
</body></html>