demo_iparam_tag

internal

A dataframe validation framework for package builders who use
dataframes as function parameters. It performs checks on column names, coerces
data-types, and checks grouping to make sure user inputs conform to a
specification provided by the package author. It provides a mechanism for
package authors to automatically document supported dataframe inputs and
selectively dispatch to functions depending on the format of a dataframe much
like S3 does for classes. It also contains some developer tools to make
working with and documenting dataframe specifications easier. It helps package
developers to improve their documentation and simplifies parameter validation
where dataframes are used as function parameters.

Robert Challen

interfacer

Define and Enforce Contracts for Dataframes as Function
Parameters

demo_iparam_tag function

<dl><dt>mydata</dt>
<dd>description of a dataframe - format automatically documented - a dataframe with columns:<ul>
<li>id (integer) - an integer ID</li>
<li>test (logical) - the test result</li>
</ul></dd>Any grouping allowed.
<dt>another</dt>
<dd>an example</dd>
<dt>...</dt>
<dd>not used</dd></dl>

Arguments

An example function — demo_iparam_tag

<dl>

<dt>mydata</dt>
<dd>description of a dataframe - format automatically documented - a dataframe with columns:<ul>
<li>id (integer) - an integer ID</li>
<li>test (logical) - the test result</li>
</ul>

Any grouping allowed.</dd>


<dt>another</dt>
<dd>an example</dd>


<dt>...</dt>
<dd>not used</dd>

</dl>

demo_iparam_tag: An example function

Description

Usage

Value

Arguments