index.default

Given a cell class create an index representation. If no source
is specified no index will be generated.

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

index.default function

<dl><dt>object</dt>
<dd>cell; The cell for indexing</dd>
<dt>id</dt>
<dd>character; an additional specifier for the object key</dd>
<dt>name</dt>
<dd>character; optional names of elements inside object</dd>
<dt>key.len</dt>
<dd>numeric; length of generated key</dd>
<dt>...</dt>
<dd>additional arguments to renderer. Unused</dd></dl>

Arguments

Generate an index from a cell object — index.default

<dl>

<dt>object</dt>
<dd>cell; The cell for indexing</dd>


<dt>id</dt>
<dd>character; an additional specifier for the object key</dd>


<dt>name</dt>
<dd>character; optional names of elements inside object</dd>


<dt>key.len</dt>
<dd>numeric; length of generated key</dd>


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

</dl>

index.default: Generate an index from a cell object

Description

Usage

Value

Arguments