mirror of
https://github.com/ryantimpe/brickr.git
synced 2026-01-01 03:09:37 -06:00
330 lines
11 KiB
HTML
330 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>Function reference • 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/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" />
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" 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>
|
|
|
|
<!-- headroom.js -->
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script>
|
|
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/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="Function reference" />
|
|
<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-index">
|
|
<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.2.0</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 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="fab fa fab fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
</div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
|
|
</header>
|
|
|
|
<div class="row">
|
|
<div class="contents col-md-9">
|
|
<div class="page-header">
|
|
<h1>Reference</h1>
|
|
</div>
|
|
|
|
<table class="ref-index">
|
|
|
|
<colgroup>
|
|
|
|
<col class="alias" />
|
|
<col class="title" />
|
|
</colgroup>
|
|
|
|
<tbody>
|
|
<tr>
|
|
<th colspan="2">
|
|
<h2 id="section-mosaics" class="hasAnchor"><a href="#section-mosaics" class="anchor"></a>Mosaics</h2>
|
|
<p class="section-desc"><p>Create a LEGO mosaic from an image</p></p>
|
|
</th>
|
|
</tr>
|
|
<tr>
|
|
|
|
<td>
|
|
<p><code><a href="build_mosaic.html">build_mosaic()</a></code> </p>
|
|
</td>
|
|
<td><p>Display 2D LEGO mosaic as a plot image</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="image_to_mosaic.html">image_to_mosaic()</a></code> </p>
|
|
</td>
|
|
<td><p>Create a 2D LEGO mosaic from an image array</p></td>
|
|
</tr>
|
|
</tbody><tbody>
|
|
<tr>
|
|
<th colspan="2">
|
|
<h2 id="section--d-models" class="hasAnchor"><a href="#section--d-models" class="anchor"></a>3D Models</h2>
|
|
<p class="section-desc"><p>Build 3D models from various inputs</p></p>
|
|
</th>
|
|
</tr>
|
|
<tr>
|
|
|
|
<td>
|
|
<p><code><a href="bricks_from_coords.html">bricks_from_coords()</a></code> </p>
|
|
</td>
|
|
<td><p>Convert a data frame with x, y, z & Color columns into a brickr 3D object</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="bricks_from_excel.html">bricks_from_excel()</a></code> </p>
|
|
</td>
|
|
<td><p>Convert an Excel brickr template into a brickr 3D object</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="bricks_from_mosaic.html">bricks_from_mosaic()</a></code> </p>
|
|
</td>
|
|
<td><p>Convert a 2D LEGO mosaic into a brickr 3D object</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="bricks_from_rayshader.html">bricks_from_rayshader()</a></code> </p>
|
|
</td>
|
|
<td><p>Build a brickr 3D object from rayshader hillshade & heightmap matrices</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="bricks_from_table.html">bricks_from_table()</a></code> </p>
|
|
</td>
|
|
<td><p>Convert a matrix table into a brickr 3D object</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="build_bricks.html">build_bricks()</a></code> </p>
|
|
</td>
|
|
<td><p>Build 3D brick model with rgl</p></td>
|
|
</tr>
|
|
</tbody><tbody>
|
|
<tr>
|
|
<th colspan="2">
|
|
<h2 id="section-ggplot-extension" class="hasAnchor"><a href="#section-ggplot-extension" class="anchor"></a>ggplot Extension</h2>
|
|
<p class="section-desc"><p>Brick bar charts in ggplot</p></p>
|
|
</th>
|
|
</tr>
|
|
<tr>
|
|
|
|
<td>
|
|
<p><code><a href="coord-brick.html">coord_brick()</a></code> <code><a href="coord-brick.html">coord_brick_flip()</a></code> </p>
|
|
</td>
|
|
<td><p>Cartesian coordinates for bricks - ggplot2 extension</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="geom_brick_col.html">geom_brick_col()</a></code> </p>
|
|
</td>
|
|
<td><p>Bar charts with bricks - ggplot2 extension</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="geom_brick_rect.html">geom_brick_rect()</a></code> </p>
|
|
</td>
|
|
<td><p>Tile charts as Bricks - ggplot2 extension</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="scale_fill_brick.html">scale_fill_brick()</a></code> </p>
|
|
</td>
|
|
<td><p>Color scales for bricks - ggplot2 extension</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="theme_brick.html">theme_brick()</a></code> </p>
|
|
</td>
|
|
<td><p>Brick color themes - ggplot2 extension</p></td>
|
|
</tr>
|
|
</tbody><tbody>
|
|
<tr>
|
|
<th colspan="2">
|
|
<h2 id="section-bricks-irl" class="hasAnchor"><a href="#section-bricks-irl" class="anchor"></a>Bricks IRL</h2>
|
|
<p class="section-desc"><p>Helper functions to create bricks and build them IRL.</p></p>
|
|
</th>
|
|
</tr>
|
|
<tr>
|
|
|
|
<td>
|
|
<p><code><a href="build_colors.html">build_colors()</a></code> </p>
|
|
</td>
|
|
<td><p>Display available brick colors</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="build_instructions.html">build_instructions()</a></code> </p>
|
|
</td>
|
|
<td><p>Create instruction manual for 2D image mosaics</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="build_pieces.html">build_pieces()</a></code> </p>
|
|
</td>
|
|
<td><p>Display bricks required to build model or mosaic.</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="build_pieces_table.html">build_pieces_table()</a></code> </p>
|
|
</td>
|
|
<td><p>Generate required bricks as a data frame.</p></td>
|
|
</tr><tr>
|
|
|
|
<td>
|
|
<p><code><a href="build_themes.html">build_themes()</a></code> </p>
|
|
</td>
|
|
<td><p>Display available brick themes for ggplot feature scale_fill_brick()</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</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="#section-mosaics">Mosaics</a></li>
|
|
<li><a href="#section--d-models">3D Models</a></li>
|
|
<li><a href="#section-ggplot-extension">ggplot Extension</a></li>
|
|
<li><a href="#section-bricks-irl">Bricks IRL</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.4.1.</p>
|
|
</div>
|
|
|
|
</footer>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|
|
|