mirror of
https://github.com/agdamsbo/FreesearchR.git
synced 2025-09-12 18:09:39 +02:00
140 lines
15 KiB
HTML
140 lines
15 KiB
HTML
<!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>Beautiful sankey plot — plot_sankey_single • FreesearchR</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/Montserrat-0.4.10/font.css" rel="stylesheet"><link href="../deps/Public_Sans-0.4.10/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="Beautiful sankey plot — plot_sankey_single"><meta name="description" content="Beautiful sankey plot"><meta property="og:description" content="Beautiful sankey plot"><meta property="og:image" content="https://agdamsbo.github.io/FreesearchR/logo.png"><script defer src="https://analytics.gdamsbo.dk/script.js" data-website-id="1f3baf18-29aa-4612-931b-58ea35922ae4"></script></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">FreesearchR</a>
|
||
|
||
<small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">25.4.5</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="../articles/FreesearchR.html">Get started</a></li>
|
||
<li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
|
||
<li class="nav-item dropdown">
|
||
<button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
|
||
<ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/data-types.html">Data types</a></li>
|
||
<li><a class="dropdown-item" href="../articles/session.html">Session info</a></li>
|
||
<li><a class="dropdown-item" href="../articles/visuals.html">On visuals</a></li>
|
||
</ul></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&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/FreesearchR/" 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">
|
||
<img src="../logo.png" class="logo" alt=""><h1>Beautiful sankey plot</h1>
|
||
<small class="dont-index">Source: <a href="https://github.com/agdamsbo/FreesearchR/blob/main/R/plot_sankey.R" class="external-link"><code>R/plot_sankey.R</code></a></small>
|
||
<div class="d-none name"><code>plot_sankey_single.Rd</code></div>
|
||
</div>
|
||
|
||
<div class="ref-description section level2">
|
||
<p>Beautiful 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">plot_sankey_single</span><span class="op">(</span></span>
|
||
<span> <span class="va">data</span>,</span>
|
||
<span> <span class="va">pri</span>,</span>
|
||
<span> <span class="va">sec</span>,</span>
|
||
<span> color.group <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">"pri"</span>, <span class="st">"sec"</span><span class="op">)</span>,</span>
|
||
<span> colors <span class="op">=</span> <span class="cn">NULL</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 id="arg-color-group">color.group<a class="anchor" aria-label="anchor" href="#arg-color-group"></a></dt>
|
||
<dd><p>set group to colour by. "x" or "y".</p></dd>
|
||
|
||
|
||
<dt id="arg-colors">colors<a class="anchor" aria-label="anchor" href="#arg-colors"></a></dt>
|
||
<dd><p>optinally specify colors. Give NA color, color for each level
|
||
in primary group and color for each level in secondary group.</p></dd>
|
||
|
||
|
||
<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
|
||
<dd><p>passed to sankey_ready()</p></dd>
|
||
|
||
</dl></div>
|
||
<div class="section level2">
|
||
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
||
<p>ggplot2 object</p>
|
||
</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"><-</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">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><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="va">ds</span> <span class="op">|></span> <span class="fu">plot_sankey_single</span><span class="op">(</span><span class="st">"first"</span>, <span class="st">"last"</span><span class="op">)</span></span></span>
|
||
<span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some strata appear at multiple axes.</span>
|
||
<span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some strata appear at multiple axes.</span>
|
||
<span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some strata appear at multiple axes.</span>
|
||
<span class="r-plt img"><img src="plot_sankey_single-1.png" alt="" width="700" height="433"></span>
|
||
<span class="r-in"><span><span class="va">ds</span> <span class="op">|></span> <span class="fu">plot_sankey_single</span><span class="op">(</span><span class="st">"first"</span>, <span class="st">"last"</span>, color.group <span class="op">=</span> <span class="st">"sec"</span><span class="op">)</span></span></span>
|
||
<span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some strata appear at multiple axes.</span>
|
||
<span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some strata appear at multiple axes.</span>
|
||
<span class="r-wrn co"><span class="r-pr">#></span> <span class="warning">Warning: </span>Some strata appear at multiple axes.</span>
|
||
<span class="r-plt img"><img src="plot_sankey_single-2.png" alt="" width="700" height="433"></span>
|
||
<span class="r-in"><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></span></span>
|
||
<span class="r-in"><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>,</span></span>
|
||
<span class="r-in"><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>,</span></span>
|
||
<span class="r-in"><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="cn">TRUE</span>, <span class="cn">FALSE</span>, <span class="cn">FALSE</span><span class="op">)</span>, <span class="fl">100</span>, <span class="cn">TRUE</span><span class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="op">)</span> <span class="op">|></span></span></span>
|
||
<span class="r-in"><span> <span class="fu">plot_sankey_single</span><span class="op">(</span><span class="st">"first"</span>, <span class="st">"last"</span>, color.group <span class="op">=</span> <span class="st">"pri"</span><span class="op">)</span></span></span>
|
||
<span class="r-plt img"><img src="plot_sankey_single-3.png" alt="" width="700" height="433"></span>
|
||
<span class="r-in"><span><span class="va">mtcars</span> <span class="op">|></span></span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="default_parsing.html">default_parsing</a></span><span class="op">(</span><span class="op">)</span> <span class="op">|></span></span></span>
|
||
<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/utils/str.html" class="external-link">str</a></span><span class="op">(</span><span class="op">)</span></span></span>
|
||
<span class="r-out co"><span class="r-pr">#></span> tibble [32 × 11] (S3: tbl_df/tbl/data.frame)</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ mpg : num [1:32] 21 21 22.8 21.4 18.7 18.1 14.3 24.4 22.8 19.2 ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ cyl : Factor w/ 3 levels "4","6","8": 2 2 1 2 3 2 3 1 1 2 ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ disp: num [1:32] 160 160 108 258 360 ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ hp : num [1:32] 110 110 93 110 175 105 245 62 95 123 ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ drat: num [1:32] 3.9 3.9 3.85 3.08 3.15 2.76 3.21 3.69 3.92 3.92 ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ wt : num [1:32] 2.62 2.88 2.32 3.21 3.44 ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ qsec: num [1:32] 16.5 17 18.6 19.4 17 ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ vs : logi [1:32] FALSE FALSE TRUE TRUE FALSE TRUE ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ am : logi [1:32] TRUE TRUE TRUE FALSE FALSE FALSE ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ gear: Factor w/ 3 levels "3","4","5": 2 2 2 1 1 1 1 2 2 2 ...</span>
|
||
<span class="r-out co"><span class="r-pr">#></span> $ carb: Factor w/ 6 levels "1","2","3","4",..: 4 4 1 1 2 1 4 2 2 4 ...</span>
|
||
<span class="r-in"><span><span class="fu">plot_sankey_single</span><span class="op">(</span><span class="st">"cyl"</span>, <span class="st">"vs"</span>, color.group <span class="op">=</span> <span class="st">"pri"</span><span class="op">)</span></span></span>
|
||
<span class="r-err co"><span class="r-pr">#></span> <span class="error">Error in plot_sankey_single("cyl", "vs", color.group = "pri"):</span> argument "sec" is missing, with no default</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.2.</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>
|
||
|