ASTTableFormula

<p>The root ASTNode of a formula.</p>
<p>The root ASTNode of a formula.</p>

data

Provides an extensible formula system to quickly and easily create
production quality tables. The processing steps are a formula parser,
statistical content generation from data as defined by formula, followed by
rendering into a table. Each step of the processing is separate and user
definable thus creating a set of composable building blocks for
highly customizable table generation. A user is not limited by any of the
choices of the package creator other than the formula grammar. For example,
one could chose to add a different S3 rendering function and output a format
not provided in the default package, or possibly one would rather have Gini
coefficients for their statistical content in a resulting table. Routines to
achieve New England Journal of Medicine style, Lancet style and
Hmisc::summaryM() statistics are provided. The package contains rendering
for HTML5, Rmarkdown and an indexing format for use in tracing and tracking
are provided.

Shawn Garbett

tangram

The Grammar of Tables

Thomas Stewart

Jennifer Thompson

Frank Harrell

Ahra Kim

ASTTableFormula function

Format

<p><code>tangram::ASTNode</code> -&gt; <code>tangram::ASTBranch</code> -&gt; <code>ASTTableFormula</code></p>

Super classes

<p><div class="r6-fields"></div></p><dl>
<dt><code>left</code></dt>
<dd><p>The AST tree for the columns.</p></dd><p></p><p>
<dt><code>right</code></dt>
<dd><p>The AST tree for the rows.</p></dd></p><p>
</p></dl><p></p>

Public fields


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/ASTTableFormula%24new()?package=tangram&version=0.8.2" data-mini-rdoc="tangram::ASTTableFormula$new()"><code>ASTTableFormula$new()</code></a></p></li>
<li><p><a href="/link/ASTTableFormula%24terms()?package=tangram&version=0.8.2" data-mini-rdoc="tangram::ASTTableFormula$terms()"><code>ASTTableFormula$terms()</code></a></p></li>
<li><p><a href="/link/ASTTableFormula%24string()?package=tangram&version=0.8.2" data-mini-rdoc="tangram::ASTTableFormula$string()"><code>ASTTableFormula$string()</code></a></p></li>
<li><p><a href="/link/ASTTableFormula%24clone()?package=tangram&version=0.8.2" data-mini-rdoc="tangram::ASTTableFormula$clone()"><code>ASTTableFormula$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="tangram" data-topic="ASTNode" data-id="set_format"><a href="/link/tangram%3A%3AASTNode%24set_format()?package=tangram&version=0.8.2" data-mini-rdoc="tangram::tangram::ASTNode$set_format()"><code>tangram::ASTNode$set_format()</code></a></span></li>
<li><span class="pkg-link" data-pkg="tangram" data-topic="ASTBranch" data-id="distribute"><a href="/link/tangram%3A%3AASTBranch%24distribute()?package=tangram&version=0.8.2" data-mini-rdoc="tangram::tangram::ASTBranch$distribute()"><code>tangram::ASTBranch$distribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="tangram" data-topic="ASTBranch" data-id="reduce"><a href="/link/tangram%3A%3AASTBranch%24reduce()?package=tangram&version=0.8.2" data-mini-rdoc="tangram::tangram::ASTBranch$reduce()"><code>tangram::ASTBranch$reduce()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-ASTTableFormula-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Create a new formula node</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ASTTableFormula$new(left, right)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>left</code></dt>
<dd><p>The left side of the "~" as an AST</p></dd></dl></div></p><p>
<dt><code>right</code></dt>
<dd><p>The right side of the "~" as an AST</p></dd></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-ASTTableFormula-terms"></a></p><div class="section" id="method-terms-">
<h3>Method <code><a href="/link/terms()?package=tangram&version=0.8.2" data-mini-rdoc="tangram::terms()">terms()</a></code></h3>
<p>Returns all terminal nodes from left and right</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ASTTableFormula$terms()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-ASTTableFormula-string"></a></p><div class="section" id="method-string-">
<h3>Method <code>string()</code></h3>
<p>A re-parseable string representing the AST</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ASTTableFormula$string()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-ASTTableFormula-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>ASTTableFormula$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

The root ASTNode of a formula. — ASTTableFormula

<p><div class="r6-fields"></p><dl>
<dt><code>left</code></dt>
<dd><p>The AST tree for the columns.</p></dd>


<dt><code>right</code></dt>
<dd><p>The AST tree for the rows.</p></dd>


</dl><p></div></p>


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-ASTTableFormula-new'><code>ASTTableFormula$new()</code></a></p></li>
<li><p><a href='#method-ASTTableFormula-terms'><code>ASTTableFormula$terms()</code></a></p></li>
<li><p><a href='#method-ASTTableFormula-string'><code>ASTTableFormula$string()</code></a></p></li>
<li><p><a href='#method-ASTTableFormula-clone'><code>ASTTableFormula$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="tangram" data-topic="ASTNode" data-id="set_format"><a href='../../tangram/html/ASTNode.html#method-ASTNode-set_format'><code>tangram::ASTNode$set_format()</code></a></span></li>
<li><span class="pkg-link" data-pkg="tangram" data-topic="ASTBranch" data-id="distribute"><a href='../../tangram/html/ASTBranch.html#method-ASTBranch-distribute'><code>tangram::ASTBranch$distribute()</code></a></span></li>
<li><span class="pkg-link" data-pkg="tangram" data-topic="ASTBranch" data-id="reduce"><a href='../../tangram/html/ASTBranch.html#method-ASTBranch-reduce'><code>tangram::ASTBranch$reduce()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-ASTTableFormula-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Create a new formula node</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ASTTableFormula$new(left, right)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>left</code></dt>
<dd><p>The left side of the "~" as an AST</p></dd>


<dt><code>right</code></dt>
<dd><p>The right side of the "~" as an AST</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-ASTTableFormula-terms"></a></p><div class='section' id='method-terms-'>
<h3>Method <code><a href='https://rdrr.io/r/stats/terms.html'>terms()</a></code></h3>
<p>Returns all terminal nodes from left and right</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ASTTableFormula$terms()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-ASTTableFormula-string"></a></p><div class='section' id='method-string-'>
<h3>Method <code>string()</code></h3>
<p>A re-parseable string representing the AST</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ASTTableFormula$string()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-ASTTableFormula-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>ASTTableFormula$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


ASTTableFormula: The root ASTNode of a formula.

Description

Arguments

Format

Super classes

Public fields

Methods

Public methods

Method `new()`

Usage

Arguments

Method `terms()`

Usage

Method `string()`

Usage

Method `clone()`

Usage

Arguments

Examples

Description

Arguments

Format

Super classes

Public fields

Methods

Public methods

Method new()

Usage

Arguments

Method terms()

Usage

Method string()

Usage

Method clone()

Usage

Arguments

Examples

Method `new()`

Method `terms()`

Method `string()`

Method `clone()`