mirror of
https://github.com/ryantimpe/brickr.git
synced 2025-12-30 10:19:43 -06:00
291 lines
14 KiB
HTML
291 lines
14 KiB
HTML
<!-- 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>Bar charts with bricks - ggplot2 extension — geom_brick_col • brickr</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" />
|
|
<!-- 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>
|
|
|
|
|
|
|
|
<link href="../extra.css" rel="stylesheet">
|
|
|
|
<meta property="og:title" content="Bar charts with bricks - ggplot2 extension — geom_brick_col" />
|
|
|
|
<meta property="og:description" content="geom_brick_col() is the brickr version of ggplot2::geom_col().
|
|
Bar height is determined by values in the data using the y aesthetic. With the exception of fill, aesthetics available in ggplot2::geom_col() are generally not enabled here." />
|
|
|
|
<meta property="og:image" content="http://brickr.org/logo.png" />
|
|
<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">brickr</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.1.0.9024</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/graphs.html">ggplot with brickr</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/models-from-other.html">3D Models from mosaics & rayshader</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/models-from-program.html">3D Models programmatically</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/models-from-tables.html">3D models from tables</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/mosaics.html">Mosaics with brickr</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/ryantimpe/brickr">
|
|
<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>Bar charts with bricks - ggplot2 extension</h1>
|
|
<small class="dont-index">Source: <a href='https://github.com/ryantimpe/brickr/blob/master/R/geom-brick-col.R'><code>R/geom-brick-col.R</code></a></small>
|
|
<div class="hidden name"><code>geom_brick_col.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
|
|
<p><code>geom_brick_col()</code> is the <code>brickr</code> version of <code><a href='https://ggplot2.tidyverse.org/reference/geom_bar.html'>ggplot2::geom_col()</a></code>.
|
|
Bar height is determined by values in the data using the <code>y</code> aesthetic. With the exception of <code>fill</code>, aesthetics available in <code><a href='https://ggplot2.tidyverse.org/reference/geom_bar.html'>ggplot2::geom_col()</a></code> are generally not enabled here.</p>
|
|
|
|
</div>
|
|
|
|
<pre class="usage"><span class='fu'>geom_brick_col</span>(<span class='kw'>mapping</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>data</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>position</span> <span class='kw'>=</span> <span class='st'>"dodge"</span>,
|
|
<span class='kw'>two_knob</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>split_bricks</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>min_radius_for_text</span> <span class='kw'>=</span> <span class='fl'>0.02</span>,
|
|
<span class='kw'>label</span> <span class='kw'>=</span> <span class='st'>"brickr"</span>, <span class='kw'>label_scale</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>...</span>, <span class='kw'>width</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>na.rm</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>show.legend</span> <span class='kw'>=</span> <span class='fl'>NA</span>, <span class='kw'>inherit.aes</span> <span class='kw'>=</span> <span class='fl'>TRUE</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>mapping</th>
|
|
<td><p>Set of aesthetic mappings created by <code>aes()</code> or
|
|
<code>aes_()</code>. If specified and <code>inherit.aes = TRUE</code> (the
|
|
default), it is combined with the default mapping at the top level of the
|
|
plot. You must supply <code>mapping</code> if there is no plot mapping.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>data</th>
|
|
<td><p>The data to be displayed in this layer. There are three
|
|
options:</p>
|
|
<p>If <code>NULL</code>, the default, the data is inherited from the plot
|
|
data as specified in the call to <code>ggplot()</code>.</p>
|
|
<p>A <code>data.frame</code>, or other object, will override the plot
|
|
data. All objects will be fortified to produce a data frame. See
|
|
<code>fortify()</code> for which variables will be created.</p>
|
|
<p>A <code>function</code> will be called with a single argument,
|
|
the plot data. The return value must be a <code>data.frame</code>, and
|
|
will be used as the layer data. A <code>function</code> can be created
|
|
from a <code>formula</code> (e.g. <code>~ head(.x, 10)</code>).</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>position</th>
|
|
<td><p>It it not recommended to use <code>position = "stack"</code>.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>two_knob</th>
|
|
<td><p>Logical. Each bar is two knobs / studs wide. When rendering many <code>x</code> values, set to <code>FALSE</code>.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>split_bricks</th>
|
|
<td><p>Logical. For simpler bars, do not split into individual bricks. Knobs still render.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>min_radius_for_text</th>
|
|
<td><p>Knob radius as a percentage of view port. If the calculated radius is lower than this value, embossed label will not appear in knobs.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>label</th>
|
|
<td><p>Character string to include as embossed text inside brick knobs. Maximum 6 characters.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>label_scale</th>
|
|
<td><p>Scale text size of label as a percentage.
|
|
Sizing for the embossed text can be off. A best attempt at the text size is calculated from the device size. Zooming a plot in the RStudio window will not update the text size.
|
|
If the automated size doesn't look correct after rendering the chart, use this scale.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>...</th>
|
|
<td><p>Other arguments passed on to <code>layer()</code>. These are
|
|
often aesthetics, used to set an aesthetic to a fixed value, like
|
|
<code>colour = "red"</code> or <code>size = 3</code>. They may also be parameters
|
|
to the paired geom/stat.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>width</th>
|
|
<td><p>Bar width. By default, set to 90% of the resolution of the data.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>na.rm</th>
|
|
<td><p>If <code>FALSE</code>, the default, missing values are removed with
|
|
a warning. If <code>TRUE</code>, missing values are silently removed.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>show.legend</th>
|
|
<td><p>logical. Should this layer be included in the legends?
|
|
<code>NA</code>, the default, includes if any aesthetics are mapped.
|
|
<code>FALSE</code> never includes, and <code>TRUE</code> always includes.
|
|
It can also be a named logical vector to finely select the aesthetics to
|
|
display.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>inherit.aes</th>
|
|
<td><p>If <code>FALSE</code>, overrides the default aesthetics,
|
|
rather than combining with them. This is most useful for helper functions
|
|
that define both data and aesthetics and shouldn't inherit behaviour from
|
|
the default plot specification, e.g. <code>borders()</code>.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
|
|
|
|
<div class='dont-index'><p>Other Graphs: <code><a href='coord-brick.html'>coord_brick</a></code>,
|
|
<code><a href='geom_brick_rect.html'>geom_brick_rect</a></code>,
|
|
<code><a href='scale_fill_brick.html'>scale_fill_brick</a></code>, <code><a href='theme_brick.html'>theme_brick</a></code></p></div>
|
|
|
|
|
|
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
|
|
<pre class="examples"><div class='input'><span class='co'>#geom_brick_col should be used in conjunction with other brickr charting </span>
|
|
<span class='co'>#functions, especially coord_brick.</span>
|
|
<span class='no'>df</span> <span class='kw'><-</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/data.frame'>data.frame</a></span>(<span class='kw'>trt</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/c'>c</a></span>(<span class='st'>"a"</span>, <span class='st'>"b"</span>, <span class='st'>"c"</span>), <span class='kw'>outcome</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/c'>c</a></span>(<span class='fl'>2.3</span>, <span class='fl'>1.9</span>, <span class='fl'>3.2</span>))
|
|
<span class='fu'>ggplot</span>(<span class='no'>df</span>, <span class='fu'>aes</span>(<span class='no'>trt</span>, <span class='no'>outcome</span>)) +
|
|
<span class='fu'>geom_brick_col</span>() +
|
|
<span class='fu'><a href='coord-brick.html'>coord_brick</a></span>()</div><div class='img'><img src='geom_brick_col-1.png' alt='' width='700' height='433' /></div><div class='input'>
|
|
<span class='co'>#For official LEGO colors, use with scale_fill_brick and theme_brick.</span>
|
|
<span class='fu'>ggplot</span>(<span class='no'>df</span>, <span class='fu'>aes</span>(<span class='no'>trt</span>, <span class='no'>outcome</span>)) +
|
|
<span class='fu'>geom_brick_col</span>(<span class='fu'>aes</span>(<span class='kw'>fill</span> <span class='kw'>=</span> <span class='no'>trt</span>)) +
|
|
<span class='fu'><a href='scale_fill_brick.html'>scale_fill_brick</a></span>() +
|
|
<span class='fu'><a href='coord-brick.html'>coord_brick</a></span>() +
|
|
<span class='fu'><a href='theme_brick.html'>theme_brick</a></span>()</div><div class='img'><img src='geom_brick_col-2.png' alt='' width='700' height='433' /></div></pre>
|
|
</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="#see-also">See also</a></li>
|
|
|
|
<li><a href="#examples">Examples</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<footer>
|
|
<div class="copyright">
|
|
<p>Developed by Ryan Timpe.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p>
|
|
</div>
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|