html5.tangram

Given a tangram class, a series of conversion creates an HTML5
representation of the table. It may be an HTML5 fragment or it may
be a complete web page.

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

html5.tangram function

<dl><dt>object</dt>
<dd>The cell table to render to HTML5</dd>
<dt>id</dt>
<dd>A unique identifier for the table (strongly recommended). If not provided, caption will be used.</dd>
<dt>caption</dt>
<dd>A string caption for the table</dd>
<dt>fragment</dt>
<dd>A boolean flag that determines whether a fragment or a complete HTML5 document is generatedf</dd>
<dt>style</dt>
<dd>A string containing a style filename to include as inline CSS. It first searches the drive for the file, if that fails it looks inside the package for a matching css file.</dd>
<dt>footnote</dt>
<dd>Any footnotes to include under the table.</dd>
<dt>inline</dt>
<dd>DEPRECATED</dd>
<dt>fixed_thead</dt>
<dd>logical; fixes the header using position sticky in CSS defaults to FALSE</dd>
<dt>...</dt>
<dd>additional arguments to renderer. Unused</dd></dl>

Arguments

Convert a tangram class into an HTML5 string — html5.tangram

<dl>

<dt>object</dt>
<dd>The cell table to render to HTML5</dd>


<dt>id</dt>
<dd>A unique identifier for the table (strongly recommended). If not provided, caption will be used.</dd>


<dt>caption</dt>
<dd>A string caption for the table</dd>


<dt>fragment</dt>
<dd>A boolean flag that determines whether a fragment or a complete HTML5 document is generatedf</dd>


<dt>style</dt>
<dd>A string containing a style filename to include as inline CSS. It first searches the drive for the file, if that fails it looks inside the package for a matching css file.</dd>


<dt>footnote</dt>
<dd>Any footnotes to include under the table.</dd>


<dt>inline</dt>
<dd>DEPRECATED</dd>


<dt>fixed_thead</dt>
<dd>logical; fixes the header using position sticky in CSS defaults to FALSE</dd>


<dt>...</dt>
<dd>additional arguments to renderer. Unused</dd>

</dl>

html5.tangram: Convert a tangram class into an HTML5 string

Description

Usage

Value

Arguments

Details