You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
260 lines
14 KiB
260 lines
14 KiB
<!-- Generated by pkgdown: do not edit by hand -->
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>X & Y scales with opinionated pre-sets for percent & comma label formats — scale_x_percent • hrbrthemes</title>
|
|
|
|
<!-- jquery -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
|
|
<!-- Bootstrap -->
|
|
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
|
|
|
|
<!-- Font Awesome icons -->
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />
|
|
|
|
<!-- clipboard.js -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script>
|
|
|
|
<!-- sticky kit -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>
|
|
|
|
<!-- pkgdown -->
|
|
<link href="../pkgdown.css" rel="stylesheet">
|
|
<script src="../pkgdown.js"></script>
|
|
|
|
|
|
|
|
<meta property="og:title" content="X & Y scales with opinionated pre-sets for percent & comma label formats — scale_x_percent" />
|
|
|
|
<meta property="og:description" content="The _comma ones set comma format for axis text and expand=c(0,0) (you need to set limits)." />
|
|
<meta name="twitter:card" content="summary" />
|
|
|
|
|
|
|
|
<!-- 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>
|
|
<div class="container template-reference-topic">
|
|
<header>
|
|
<div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">hrbrthemes</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.6.0</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li>
|
|
<a href="../index.html">
|
|
<span class="fa fa-home fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li class="dropdown">
|
|
<a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
|
|
Articles
|
|
|
|
<span class="caret"></span>
|
|
</a>
|
|
<ul class="dropdown-menu" role="menu">
|
|
<li>
|
|
<a href="../articles/why_hrbrthemes.html">Why hrbrthemes?</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul>
|
|
|
|
<ul class="nav navbar-nav navbar-right">
|
|
<li>
|
|
<a href="https://github.com/hrbrmstr/hrbrthemes">
|
|
<span class="fa fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
</header>
|
|
|
|
<div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>X & Y scales with opinionated pre-sets for percent & comma label formats</h1>
|
|
<small class="dont-index">Source: <a href='https://github.com/hrbrmstr/hrbrthemes/blob/master/R/scales.r'><code>R/scales.r</code></a></small>
|
|
<div class="hidden name"><code>scale_x_percent.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
|
|
<p>The <code>_comma</code> ones set comma format for axis text and <code>expand=c(0,0)</code> (you need to set limits).</p>
|
|
|
|
</div>
|
|
|
|
<pre class="usage"><span class='fu'>scale_x_percent</span>(<span class='kw'>name</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(), <span class='kw'>breaks</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(),
|
|
<span class='kw'>minor_breaks</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(), <span class='kw'>labels</span> <span class='kw'>=</span> <span class='kw pkg'>scales</span><span class='kw ns'>::</span><span class='no'><a href='https://www.rdocumentation.org/packages/scales/topics/number_format'>percent</a></span>, <span class='kw'>limits</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>expand</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/c'>c</a></span>(<span class='fl'>0.01</span>, <span class='fl'>0</span>), <span class='kw'>oob</span> <span class='kw'>=</span> <span class='no'>censor</span>, <span class='kw'>na.value</span> <span class='kw'>=</span> <span class='fl'>NA_real_</span>,
|
|
<span class='kw'>trans</span> <span class='kw'>=</span> <span class='st'>"identity"</span>, <span class='kw'>position</span> <span class='kw'>=</span> <span class='st'>"bottom"</span>, <span class='kw'>sec.axis</span> <span class='kw'>=</span> <span class='fu'>waiver</span>())
|
|
|
|
<span class='fu'>scale_y_percent</span>(<span class='kw'>name</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(), <span class='kw'>breaks</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(),
|
|
<span class='kw'>minor_breaks</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(), <span class='kw'>labels</span> <span class='kw'>=</span> <span class='kw pkg'>scales</span><span class='kw ns'>::</span><span class='no'><a href='https://www.rdocumentation.org/packages/scales/topics/number_format'>percent</a></span>, <span class='kw'>limits</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>expand</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/c'>c</a></span>(<span class='fl'>0.01</span>, <span class='fl'>0</span>), <span class='kw'>oob</span> <span class='kw'>=</span> <span class='no'>censor</span>, <span class='kw'>na.value</span> <span class='kw'>=</span> <span class='fl'>NA_real_</span>,
|
|
<span class='kw'>trans</span> <span class='kw'>=</span> <span class='st'>"identity"</span>, <span class='kw'>position</span> <span class='kw'>=</span> <span class='st'>"left"</span>, <span class='kw'>sec.axis</span> <span class='kw'>=</span> <span class='fu'>waiver</span>())
|
|
|
|
<span class='fu'>scale_x_comma</span>(<span class='kw'>name</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(), <span class='kw'>breaks</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(),
|
|
<span class='kw'>minor_breaks</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(), <span class='kw'>labels</span> <span class='kw'>=</span> <span class='kw pkg'>scales</span><span class='kw ns'>::</span><span class='no'><a href='https://www.rdocumentation.org/packages/scales/topics/number_format'>comma</a></span>, <span class='kw'>limits</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>expand</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/c'>c</a></span>(<span class='fl'>0.01</span>, <span class='fl'>0</span>), <span class='kw'>oob</span> <span class='kw'>=</span> <span class='no'>censor</span>, <span class='kw'>na.value</span> <span class='kw'>=</span> <span class='fl'>NA_real_</span>,
|
|
<span class='kw'>trans</span> <span class='kw'>=</span> <span class='st'>"identity"</span>, <span class='kw'>position</span> <span class='kw'>=</span> <span class='st'>"bottom"</span>, <span class='kw'>sec.axis</span> <span class='kw'>=</span> <span class='fu'>waiver</span>())
|
|
|
|
<span class='fu'>scale_y_comma</span>(<span class='kw'>name</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(), <span class='kw'>breaks</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(),
|
|
<span class='kw'>minor_breaks</span> <span class='kw'>=</span> <span class='fu'>waiver</span>(), <span class='kw'>labels</span> <span class='kw'>=</span> <span class='kw pkg'>scales</span><span class='kw ns'>::</span><span class='no'><a href='https://www.rdocumentation.org/packages/scales/topics/number_format'>comma</a></span>, <span class='kw'>limits</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>expand</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/c'>c</a></span>(<span class='fl'>0.01</span>, <span class='fl'>0</span>), <span class='kw'>oob</span> <span class='kw'>=</span> <span class='no'>censor</span>, <span class='kw'>na.value</span> <span class='kw'>=</span> <span class='fl'>NA_real_</span>,
|
|
<span class='kw'>trans</span> <span class='kw'>=</span> <span class='st'>"identity"</span>, <span class='kw'>position</span> <span class='kw'>=</span> <span class='st'>"left"</span>, <span class='kw'>sec.axis</span> <span class='kw'>=</span> <span class='fu'>waiver</span>())</pre>
|
|
|
|
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
|
|
<table class="ref-arguments">
|
|
<colgroup><col class="name" /><col class="desc" /></colgroup>
|
|
<tr>
|
|
<th>name</th>
|
|
<td><p>The name of the scale. Used as axis or legend title. If
|
|
<code>waiver()</code>, the default, the name of the scale is taken from the first
|
|
mapping used for that aesthetic. If <code>NULL</code>, the legend title will be
|
|
omitted.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>breaks</th>
|
|
<td><p>One of:</p><ul>
|
|
<li><p><code>NULL</code> for no breaks</p></li>
|
|
<li><p><code>waiver()</code> for the default breaks computed by the
|
|
transformation object</p></li>
|
|
<li><p>A numeric vector of positions</p></li>
|
|
<li><p>A function that takes the limits as input and returns breaks
|
|
as output</p></li>
|
|
</ul></td>
|
|
</tr>
|
|
<tr>
|
|
<th>minor_breaks</th>
|
|
<td><p>One of:</p><ul>
|
|
<li><p><code>NULL</code> for no minor breaks</p></li>
|
|
<li><p><code>waiver()</code> for the default breaks (one minor break between
|
|
each major break)</p></li>
|
|
<li><p>A numeric vector of positions</p></li>
|
|
<li><p>A function that given the limits returns a vector of minor breaks.</p></li>
|
|
</ul></td>
|
|
</tr>
|
|
<tr>
|
|
<th>labels</th>
|
|
<td><p>One of:</p><ul>
|
|
<li><p><code>NULL</code> for no labels</p></li>
|
|
<li><p><code>waiver()</code> for the default labels computed by the
|
|
transformation object</p></li>
|
|
<li><p>A character vector giving labels (must be same length as <code>breaks</code>)</p></li>
|
|
<li><p>A function that takes the breaks as input and returns labels
|
|
as output</p></li>
|
|
</ul></td>
|
|
</tr>
|
|
<tr>
|
|
<th>limits</th>
|
|
<td><p>A numeric vector of length two providing limits of the scale.
|
|
Use <code>NA</code> to refer to the existing minimum or maximum.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>expand</th>
|
|
<td><p>same as in ggplot2</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>oob</th>
|
|
<td><p>Function that handles limits outside of the scale limits
|
|
(out of bounds). The default replaces out of bounds values with NA.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>na.value</th>
|
|
<td><p>If <code>na.translate = TRUE</code>, what value aesthetic
|
|
value should missing be displayed as? Does not apply to position scales
|
|
where <code>NA</code> is always placed at the far right.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>trans</th>
|
|
<td><p>Either the name of a transformation object, or the
|
|
object itself. Built-in transformations include "asn", "atanh",
|
|
"boxcox", "exp", "identity", "log", "log10", "log1p", "log2",
|
|
"logit", "probability", "probit", "reciprocal", "reverse" and "sqrt".</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>position</th>
|
|
<td><p>The position of the axis. "left" or "right" for vertical
|
|
scales, "top" or "bottom" for horizontal scales</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>sec.axis</th>
|
|
<td><p>specify a secondary axis</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
|
|
|
|
<p>The <code>_percent</code> ones set precent format for axis text and <code>expand=c(0,0)</code> (you need to set limits).</p>
|
|
|
|
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
|
|
<h2>Contents</h2>
|
|
<ul class="nav nav-pills nav-stacked">
|
|
<li><a href="#arguments">Arguments</a></li>
|
|
|
|
<li><a href="#details">Details</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="copyright">
|
|
<p>Developed by Bob Rudis.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.2.0.</p>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|