198 lines
11 KiB
HTML
198 lines
11 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>Make dumbbell chart. — dumbbell • visualizeR</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/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><meta property="og:title" content="Make dumbbell chart. — dumbbell"><meta name="description" content="Make dumbbell chart."><meta property="og:description" content="Make dumbbell chart."><meta property="og:image" content="https://gnoblet.github.io/visualizeR/logo.png"></head><body>
|
|
<a href="#main" class="visually-hidden-focusable">Skip to contents</a>
|
|
|
|
|
|
<nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><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="">1.0</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><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/gnoblet/visualizeR/" 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>Make dumbbell chart.</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/gnoblet/visualizeR/blob/main/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="color.html">color</a></span><span class="op">(</span><span class="st">"light_blue_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">FALSE</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="color.html">color</a></span><span class="op">(</span><span class="st">"dark_grey"</span><span class="op">)</span>,</span>
|
|
<span> add_text <span class="op">=</span> <span class="cn">FALSE</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="color.html">color</a></span><span class="op">(</span><span class="st">"dark_grey"</span><span class="op">)</span>,</span>
|
|
<span> theme_fun <span class="op">=</span> <span class="fu"><a href="theme_default.html">theme_dumbbell</a></span><span class="op">(</span><span class="op">)</span>,</span>
|
|
<span> scale_fill_fun <span class="op">=</span> <span class="fu"><a href="scale_color_visualizer_discrete.html">scale_fill_visualizer_discrete</a></span><span class="op">(</span><span class="op">)</span>,</span>
|
|
<span> scale_color_fun <span class="op">=</span> <span class="fu"><a href="scale_color_visualizer_discrete.html">scale_color_visualizer_discrete</a></span><span class="op">(</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 id="arg-df">df<a class="anchor" aria-label="anchor" href="#arg-df"></a></dt>
|
|
<dd><p>A data frame.</p></dd>
|
|
|
|
|
|
<dt id="arg-col">col<a class="anchor" aria-label="anchor" href="#arg-col"></a></dt>
|
|
<dd><p>A numeric column.</p></dd>
|
|
|
|
|
|
<dt id="arg-group-x">group_x<a class="anchor" aria-label="anchor" href="#arg-group-x"></a></dt>
|
|
<dd><p>The grouping column on the x-axis; only two groups.</p></dd>
|
|
|
|
|
|
<dt id="arg-group-y">group_y<a class="anchor" aria-label="anchor" href="#arg-group-y"></a></dt>
|
|
<dd><p>The grouping column on the y-axis.</p></dd>
|
|
|
|
|
|
<dt id="arg-point-size">point_size<a class="anchor" aria-label="anchor" href="#arg-point-size"></a></dt>
|
|
<dd><p>Point size.</p></dd>
|
|
|
|
|
|
<dt id="arg-point-alpha">point_alpha<a class="anchor" aria-label="anchor" href="#arg-point-alpha"></a></dt>
|
|
<dd><p>Point alpha.</p></dd>
|
|
|
|
|
|
<dt id="arg-segment-size">segment_size<a class="anchor" aria-label="anchor" href="#arg-segment-size"></a></dt>
|
|
<dd><p>Segment size.</p></dd>
|
|
|
|
|
|
<dt id="arg-segment-color">segment_color<a class="anchor" aria-label="anchor" href="#arg-segment-color"></a></dt>
|
|
<dd><p>Segment color.</p></dd>
|
|
|
|
|
|
<dt id="arg-group-x-title">group_x_title<a class="anchor" aria-label="anchor" href="#arg-group-x-title"></a></dt>
|
|
<dd><p>X-group and legend title.</p></dd>
|
|
|
|
|
|
<dt id="arg-group-y-title">group_y_title<a class="anchor" aria-label="anchor" href="#arg-group-y-title"></a></dt>
|
|
<dd><p>Y-axis and group title.</p></dd>
|
|
|
|
|
|
<dt id="arg-x-title">x_title<a class="anchor" aria-label="anchor" href="#arg-x-title"></a></dt>
|
|
<dd><p>X-axis title.</p></dd>
|
|
|
|
|
|
<dt id="arg-title">title<a class="anchor" aria-label="anchor" href="#arg-title"></a></dt>
|
|
<dd><p>Title.</p></dd>
|
|
|
|
|
|
<dt id="arg-subtitle">subtitle<a class="anchor" aria-label="anchor" href="#arg-subtitle"></a></dt>
|
|
<dd><p>Subtitle.</p></dd>
|
|
|
|
|
|
<dt id="arg-caption">caption<a class="anchor" aria-label="anchor" href="#arg-caption"></a></dt>
|
|
<dd><p>Caption.</p></dd>
|
|
|
|
|
|
<dt id="arg-line-to-y-axis">line_to_y_axis<a class="anchor" aria-label="anchor" href="#arg-line-to-y-axis"></a></dt>
|
|
<dd><p>TRUE or FALSE; add a line connected points and Y-axis.</p></dd>
|
|
|
|
|
|
<dt id="arg-line-to-y-axis-type">line_to_y_axis_type<a class="anchor" aria-label="anchor" href="#arg-line-to-y-axis-type"></a></dt>
|
|
<dd><p>Line to Y-axis type.</p></dd>
|
|
|
|
|
|
<dt id="arg-line-to-y-axis-width">line_to_y_axis_width<a class="anchor" aria-label="anchor" href="#arg-line-to-y-axis-width"></a></dt>
|
|
<dd><p>Line to Y-axis width.</p></dd>
|
|
|
|
|
|
<dt id="arg-line-to-y-axis-color">line_to_y_axis_color<a class="anchor" aria-label="anchor" href="#arg-line-to-y-axis-color"></a></dt>
|
|
<dd><p>Line to Y-axis color.</p></dd>
|
|
|
|
|
|
<dt id="arg-add-text">add_text<a class="anchor" aria-label="anchor" href="#arg-add-text"></a></dt>
|
|
<dd><p>TRUE or FALSE; add text at the points.</p></dd>
|
|
|
|
|
|
<dt id="arg-add-text-vjust">add_text_vjust<a class="anchor" aria-label="anchor" href="#arg-add-text-vjust"></a></dt>
|
|
<dd><p>Vertical adjustment.</p></dd>
|
|
|
|
|
|
<dt id="arg-add-text-size">add_text_size<a class="anchor" aria-label="anchor" href="#arg-add-text-size"></a></dt>
|
|
<dd><p>Text size.</p></dd>
|
|
|
|
|
|
<dt id="arg-add-text-color">add_text_color<a class="anchor" aria-label="anchor" href="#arg-add-text-color"></a></dt>
|
|
<dd><p>Text color.</p></dd>
|
|
|
|
|
|
<dt id="arg-theme-fun">theme_fun<a class="anchor" aria-label="anchor" href="#arg-theme-fun"></a></dt>
|
|
<dd><p>A ggplot2 theme, default to `theme_dumbbell()`</p></dd>
|
|
|
|
|
|
<dt id="arg-scale-fill-fun">scale_fill_fun<a class="anchor" aria-label="anchor" href="#arg-scale-fill-fun"></a></dt>
|
|
<dd><p>A ggplot2 scale_fill function, default to `scale_fill_visualizer_discrete()`</p></dd>
|
|
|
|
|
|
<dt id="arg-scale-color-fun">scale_color_fun<a class="anchor" aria-label="anchor" href="#arg-scale-color-fun"></a></dt>
|
|
<dd><p>A ggplot2 scale_color function, default to `scale_color_visualizer_discrete()`</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" aria-label="Table of contents"><h2>On this page</h2>
|
|
</nav></aside></div>
|
|
|
|
|
|
<footer><div class="pkgdown-footer-left">
|
|
<p>Developed by Noblet Guillaume.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown-footer-right">
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.3.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|