201 lines
10 KiB
HTML
201 lines
10 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"><meta name="description" content="Make dumbbell chart."><title>Make dumbbell chart. — dumbbell • visualizeR</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><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.2.2/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.2.2/bootstrap.bundle.min.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- bootstrap-toc --><script src="https://cdn.jsdelivr.net/gh/afeld/bootstrap-toc@v1.0.1/dist/bootstrap-toc.min.js" integrity="sha256-4veVQbu7//Lk5TSmc7YV48MxtMy98e26cf5MrgZYnwo=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- search --><script src="https://cdnjs.cloudflare.com/ajax/libs/fuse.js/6.4.6/fuse.js" integrity="sha512-zv6Ywkjyktsohkbp9bb45V6tEMoWhzFzXis+LrMehmJZZSys19Yxf1dopHx7WzIKxr5tK2dVcYmaCk2uqdjF4A==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/autocomplete.js/0.38.0/autocomplete.jquery.min.js" integrity="sha512-GU9ayf+66Xx2TmpxqJpliWbT5PiGYxpaG8rfnBEk1LL8l1KGkRShhngwdXK1UgqhAzWpZHSiYPc09/NwDQIGyg==" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mark.js/8.11.1/mark.min.js" integrity="sha512-5CYOlHXGh6QpOFA/TeTylKLWfB3ftPsde7AnmhuitiTX4K5SqCLBeKro6sPS8ilsz1Q4NRx3v8Ko2IBiszzdww==" crossorigin="anonymous"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Make dumbbell chart. — dumbbell"><meta property="og:description" content="Make dumbbell chart."><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]--></head><body>
|
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
|
|
|
|
<nav class="navbar fixed-top navbar-light navbar-expand-lg bg-light"><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="">0.6.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">
|
|
<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="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul><form class="form-inline my-2 my-lg-0" role="search">
|
|
<input type="search" class="form-control me-sm-2" aria-label="Toggle navigation" name="search-input" data-search-index="../search.json" id="search-input" placeholder="Search for" autocomplete="off"></form>
|
|
|
|
<ul class="navbar-nav"><li class="nav-item">
|
|
<a class="external-link nav-link" href="https://github.com/gnoblet/visualizeR/" aria-label="github">
|
|
<span class="fab 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>Make dumbbell chart.</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/HEAD/R/dumbbell.R" class="external-link"><code>R/dumbbell.R</code></a></small>
|
|
<div class="d-none name"><code>dumbbell.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description section level2">
|
|
<p>Make dumbbell chart.</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">dumbbell</span><span class="op">(</span></span>
|
|
<span> <span class="va">df</span>,</span>
|
|
<span> <span class="va">col</span>,</span>
|
|
<span> <span class="va">group_x</span>,</span>
|
|
<span> <span class="va">group_y</span>,</span>
|
|
<span> point_size <span class="op">=</span> <span class="fl">5</span>,</span>
|
|
<span> point_alpha <span class="op">=</span> <span class="fl">1</span>,</span>
|
|
<span> segment_size <span class="op">=</span> <span class="fl">2.5</span>,</span>
|
|
<span> segment_color <span class="op">=</span> <span class="fu"><a href="cols_reach.html">cols_reach</a></span><span class="op">(</span><span class="st">"main_lt_grey"</span><span class="op">)</span>,</span>
|
|
<span> group_x_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> group_y_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> x_title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> title <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> subtitle <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> caption <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> line_to_y_axis <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> line_to_y_axis_type <span class="op">=</span> <span class="fl">3</span>,</span>
|
|
<span> line_to_y_axis_width <span class="op">=</span> <span class="fl">0.5</span>,</span>
|
|
<span> line_to_y_axis_color <span class="op">=</span> <span class="fu"><a href="cols_reach.html">cols_reach</a></span><span class="op">(</span><span class="st">"main_grey"</span><span class="op">)</span>,</span>
|
|
<span> add_text <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> add_text_vjust <span class="op">=</span> <span class="fl">2</span>,</span>
|
|
<span> add_text_size <span class="op">=</span> <span class="fl">3.5</span>,</span>
|
|
<span> add_text_color <span class="op">=</span> <span class="fu"><a href="cols_reach.html">cols_reach</a></span><span class="op">(</span><span class="st">"main_grey"</span><span class="op">)</span>,</span>
|
|
<span> theme <span class="op">=</span> <span class="fu"><a href="theme_reach.html">theme_reach</a></span><span class="op">(</span>palette <span class="op">=</span> <span class="st">"primary"</span><span class="op">)</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>df</dt>
|
|
<dd><p>A data frame.</p></dd>
|
|
|
|
|
|
<dt>col</dt>
|
|
<dd><p>A numeric column.</p></dd>
|
|
|
|
|
|
<dt>group_x</dt>
|
|
<dd><p>The grouping column on the x-axis; only two groups.</p></dd>
|
|
|
|
|
|
<dt>group_y</dt>
|
|
<dd><p>The grouping column on the y-axis.</p></dd>
|
|
|
|
|
|
<dt>point_size</dt>
|
|
<dd><p>Point size.</p></dd>
|
|
|
|
|
|
<dt>point_alpha</dt>
|
|
<dd><p>Point alpha.</p></dd>
|
|
|
|
|
|
<dt>segment_size</dt>
|
|
<dd><p>Segment size.</p></dd>
|
|
|
|
|
|
<dt>segment_color</dt>
|
|
<dd><p>Segment color.</p></dd>
|
|
|
|
|
|
<dt>group_x_title</dt>
|
|
<dd><p>X-group and legend title.</p></dd>
|
|
|
|
|
|
<dt>group_y_title</dt>
|
|
<dd><p>Y-axis and group title.</p></dd>
|
|
|
|
|
|
<dt>x_title</dt>
|
|
<dd><p>X-axis title.</p></dd>
|
|
|
|
|
|
<dt>title</dt>
|
|
<dd><p>Title.</p></dd>
|
|
|
|
|
|
<dt>subtitle</dt>
|
|
<dd><p>Subtitle.</p></dd>
|
|
|
|
|
|
<dt>caption</dt>
|
|
<dd><p>Caption.</p></dd>
|
|
|
|
|
|
<dt>line_to_y_axis</dt>
|
|
<dd><p>TRUE or FALSE; add a line connected points and Y-axis.</p></dd>
|
|
|
|
|
|
<dt>line_to_y_axis_type</dt>
|
|
<dd><p>Line to Y-axis type.</p></dd>
|
|
|
|
|
|
<dt>line_to_y_axis_width</dt>
|
|
<dd><p>Line to Y-axis width.</p></dd>
|
|
|
|
|
|
<dt>line_to_y_axis_color</dt>
|
|
<dd><p>Line to Y-axis color.</p></dd>
|
|
|
|
|
|
<dt>add_text</dt>
|
|
<dd><p>TRUE or FALSE; add text at the points.</p></dd>
|
|
|
|
|
|
<dt>add_text_vjust</dt>
|
|
<dd><p>Vertical adjustment.</p></dd>
|
|
|
|
|
|
<dt>add_text_size</dt>
|
|
<dd><p>Text size.</p></dd>
|
|
|
|
|
|
<dt>add_text_color</dt>
|
|
<dd><p>Text color.</p></dd>
|
|
|
|
|
|
<dt>theme</dt>
|
|
<dd><p>A ggplot2 theme, default to `theme_reach()`</p></dd>
|
|
|
|
</dl></div>
|
|
<div class="section level2">
|
|
<h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
|
|
|
|
|
|
<p>A dumbbell chart.</p>
|
|
</div>
|
|
|
|
</main><aside class="col-md-3"><nav id="toc"><h2>On this page</h2>
|
|
</nav></aside></div>
|
|
|
|
|
|
<footer><div class="pkgdown-footer-left">
|
|
<p></p><p>Developed by Noblet Guillaume.</p>
|
|
</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.7.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|