mirror of
https://github.com/ryantimpe/brickr.git
synced 2026-01-01 19:29:29 -06:00
267 lines
11 KiB
HTML
267 lines
11 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>Tile charts as bricks — geom_brick_rect • 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.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
|
|
<!-- Bootstrap -->
|
|
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />
|
|
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
|
|
|
|
<!-- bootstrap-toc -->
|
|
<link rel="stylesheet" href="../bootstrap-toc.css">
|
|
<script src="../bootstrap-toc.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" />
|
|
|
|
<!-- 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>
|
|
|
|
<!-- 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>
|
|
|
|
<!-- pkgdown -->
|
|
<link href="../pkgdown.css" rel="stylesheet">
|
|
<script src="../pkgdown.js"></script>
|
|
|
|
|
|
|
|
<link href="../extra.css" rel="stylesheet">
|
|
|
|
|
|
<meta property="og:title" content="Tile charts as bricks — geom_brick_rect" />
|
|
<meta property="og:description" content="geom_rect, except bars look like LEGO bricks." />
|
|
<meta property="og:image" content="http://brickr.org/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 data-spy="scroll" data-target="#toc">
|
|
<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.3.4</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav">
|
|
<li>
|
|
<a href="../index.html">
|
|
<span class="fas fa fas fa-home fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="../articles/index.html">Articles</a>
|
|
</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="fab fa fab 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>Tile charts as bricks</h1>
|
|
<small class="dont-index">Source: <a href='https://github.com/ryantimpe/brickr/blob/master/R/geom-brick-rect.R'><code>R/geom-brick-rect.R</code></a></small>
|
|
<div class="hidden name"><code>geom_brick_rect.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p><code>geom_rect</code>, except bars look like LEGO bricks.</p>
|
|
</div>
|
|
|
|
<pre class="usage"><span class='fu'>geom_brick_rect</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'>stat</span> <span class='kw'>=</span> <span class='st'>"identity"</span>,
|
|
<span class='kw'>position</span> <span class='kw'>=</span> <span class='st'>"identity"</span>,
|
|
<span class='no'>...</span>,
|
|
<span class='kw'>label</span> <span class='kw'>=</span> <span class='st'>""</span>,
|
|
<span class='kw'>simplified_threshold</span> <span class='kw'>=</span> <span class='fl'>24</span> * <span class='fl'>24</span>,
|
|
<span class='kw'>label_scale</span> <span class='kw'>=</span> <span class='fl'>1</span>,
|
|
<span class='kw'>use_bricks</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
|
|
<span class='kw'>linejoin</span> <span class='kw'>=</span> <span class='st'>"mitre"</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><a href='https://ggplot2.tidyverse.org/reference/aes.html'>aes()</a></code> or
|
|
<code><a href='https://ggplot2.tidyverse.org/reference/aes_.html'>aes_()</a></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><a href='https://ggplot2.tidyverse.org/reference/ggplot.html'>ggplot()</a></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><a href='https://ggplot2.tidyverse.org/reference/fortify.html'>fortify()</a></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>stat</th>
|
|
<td><p>The statistical transformation to use on the data for this
|
|
layer, as a string.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>position</th>
|
|
<td><p>Position adjustment, either as a string, or the result of
|
|
a call to a position adjustment function.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>...</th>
|
|
<td><p>Other arguments passed on to <code><a href='https://ggplot2.tidyverse.org/reference/layer.html'>layer()</a></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>label</th>
|
|
<td><p>Character string to include as embossed text inside brick knobs. Maximum 6 characters.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>simplified_threshold</th>
|
|
<td><p>Maximum number of knobs on the plot before embossed label is suppressed.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>label_scale</th>
|
|
<td><p>Scale text size of label as a percentage.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>use_bricks</th>
|
|
<td><p>Array of brick sizes to use in mosaic. Defaults to <code><a href='https://rdrr.io/r/base/c.html'>c('4x2', '2x2', '3x1', '2x1', '1x1')</a></code>`.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<th>linejoin</th>
|
|
<td><p>Line join style (round, mitre, bevel).</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><a href='https://ggplot2.tidyverse.org/reference/borders.html'>borders()</a></code>.</p></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
|
|
|
|
<p>Currently all 'ggplot2' extensions are for internal use only.</p>
|
|
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
|
|
<nav id="toc" data-toggle="toc" class="sticky-top">
|
|
<h2 data-toc-skip>Contents</h2>
|
|
</nav>
|
|
</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.5.1.</p>
|
|
</div>
|
|
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|