mirror/brickr
1
0
Fork 0
mirror of https://github.com/ryantimpe/brickr.git synced 2026-01-06 05:39:34 -06:00
Code Issues Packages Projects Releases Wiki Activity

Documentation and website updates for the 0.2 release

Browse Source
This commit is contained in:
ryantimpe
2019-11-03 15:42:24 -05:00
parent 67d518b1c4
commit 38b2817b5e
49 changed files with 132 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/reference/build_bricks.html
View File

@@ -200,6 +200,19 @@ Set to 'TRUE' and rgl_lit='FALSE' for cartoon-looking bricks.</p></td>
<code><a href='bricks_from_table.html'>bricks_from_table</a></code>,
<code><a href='build_bricks_rayshader.html'>build_bricks_rayshader</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='kw'>if</span> (<span class='fl'>FALSE</span>) {
<span class='co'>#This is a brick</span>
<span class='no'>brick</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(
<span class='kw'>Level</span><span class='kw'>=</span><span class='st'>"A"</span>,
<span class='kw'>X1</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span>(<span class='fl'>3</span>,<span class='fl'>4</span>), <span class='co'>#The number 3 is the brickrID for 'bright red'</span>
<span class='kw'>X2</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span>(<span class='fl'>3</span>,<span class='fl'>4</span>)
)
<span class='no'>brick</span> <span class='kw'>%&gt;%</span>
<span class='fu'><a href='bricks_from_table.html'>bricks_from_table</a></span>() <span class='kw'>%&gt;%</span>
<span class='fu'>build_bricks</span>()
}</div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
@@ -207,6 +220,7 @@ Set to 'TRUE' and rgl_lit='FALSE' for cartoon-looking bricks.</p></td>
<li><a href="#arguments">Arguments</a></li>
<li><a href="#value">Value</a></li>
<li><a href="#see-also">See also</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</div>

16
docs/reference/build_bricks_rayshader.html
View File

@@ -195,7 +195,7 @@ Enter a value for a custom resolution. High resolutions take longer to render.</
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
<p>3D brick model rendered in the 'rgl' package.</p>
<p>3D brick model rendered in the 'rayshader' package.</p>
<h2 class="hasAnchor" id="see-also"><a class="anchor" href="#see-also"></a>See also</h2>
<div class='dont-index'><p>Other 3D Models: <code><a href='bricks_from_coords.html'>bricks_from_coords</a></code>,
@@ -205,6 +205,19 @@ Enter a value for a custom resolution. High resolutions take longer to render.</
<code><a href='bricks_from_table.html'>bricks_from_table</a></code>,
<code><a href='build_bricks.html'>build_bricks</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='kw'>if</span> (<span class='fl'>FALSE</span>) {
<span class='co'>#This is a brick</span>
<span class='no'>brick</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/data.frame.html'>data.frame</a></span>(
<span class='kw'>Level</span><span class='kw'>=</span><span class='st'>"A"</span>,
<span class='kw'>X1</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span>(<span class='fl'>3</span>,<span class='fl'>4</span>), <span class='co'>#The number 3 is the brickrID for 'bright red'</span>
<span class='kw'>X2</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/rep.html'>rep</a></span>(<span class='fl'>3</span>,<span class='fl'>4</span>)
)
<span class='no'>brick</span> <span class='kw'>%&gt;%</span>
<span class='fu'><a href='bricks_from_table.html'>bricks_from_table</a></span>() <span class='kw'>%&gt;%</span>
<span class='fu'><a href='build_bricks.html'>build_bricks</a></span>()
}</div></pre>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
<h2>Contents</h2>
@@ -212,6 +225,7 @@ Enter a value for a custom resolution. High resolutions take longer to render.</
<li><a href="#arguments">Arguments</a></li>
<li><a href="#value">Value</a></li>
<li><a href="#see-also">See also</a></li>
<li><a href="#examples">Examples</a></li>
</ul>
</div>

6
docs/reference/index.html
View File

@@ -215,6 +215,12 @@
<p><code><a href="build_bricks.html">build_bricks()</a></code> </p>
</td>
<td><p>Build 3D brick model with rgl</p></td>
</tr><tr>
<td>
<p><code><a href="build_bricks_rayshader.html">build_bricks_rayshader()</a></code> </p>
</td>
<td><p>Build 3D brick model with rayshader.</p></td>
</tr>
</tbody><tbody>
<tr>