iclip

When developing with <code>interfacer</code> it is useful to be able to base a function
input off a prototype that you are for example using as testing. This
function generates an <code>interfacer::iface</code> specification for the supplied data
frame and copies it to the clipboard so that it can be pasted into the
package code you are working on.

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

iclip function

<dl><dt>df</dt>
<dd>a prototype dataframe</dd>
<dt>df_name</dt>
<dd>an optional name for the parameter (defaults to <code>i_&lt;df name&gt;</code>)</dd></dl>

Arguments

Create an iface specification from an example dataframe — iclip

<dl>

<dt>df</dt>
<dd>a prototype dataframe</dd>


<dt>df_name</dt>
<dd>an optional name for the parameter (defaults to <code>i_&lt;df name&gt;</code>)</dd>

</dl>

iclip: Create an `iface` specification from an example dataframe

Description

Usage

Value

Arguments

Details

Examples