splitForms

Separates a data frame from REDCap into a list of data
frames where each form constitutes an element in the list.

Access data stored in 'REDCap' databases using the Application
Programming Interface (API). 'REDCap' (Research Electronic Data CAPture;
<https://projectredcap.org>, Harris, et al. (2009) <doi:10.1016/j.jbi.2008.08.010>,
Harris, et al. (2019) <doi:10.1016/j.jbi.2019.103208>) is
a web application for building and managing online surveys and databases
developed at Vanderbilt University. The API allows users to access data
and project meta data (such as the data dictionary) from the web
programmatically. The 'redcapAPI' package facilitates the process of
accessing data with options to prepare an analysis-ready data set
consistent with the definitions in a database's data dictionary.

Shawn Garbett

redcapAPI

Interface to 'REDCap'

Benjamin Nutter

Stephen Lane

Will Beasley

Jeffrey Horner

Will Gray

Jeremy Stephens

Marcus Lehr

Cole Beck

Savannah Obregon

splitForms function

<dl><dt>Records</dt>
<dd><code>data.frame</code> such as one generated by <code>exportRecords</code> or
<code>exportRecordsTyped</code></dd>
<dt>rcon</dt>
<dd>A <code>redcapConnection</code> object.</dd>
<dt>envir</dt>
<dd>environment. The target environment for the resulting list
of <code>data.frame</code>s. Defaults to <code>NULL</code> which returns the a list.
Use <code>globalenv</code> to assign the global environment. Will accept a number
of the environment.</dd>
<dt>base</dt>
<dd><code>character(1)</code> giving the start of the naming scheme
for the elements of the list. By default, the names of the list will
be the form names. If this value is provided, it will follow the
format <code>base.form_name</code>.</dd>
<dt>post</dt>
<dd><code>function</code> to apply to each element of form data
after separating them, must be of signature <code>function(data, rcon)</code>.</dd></dl>

Arguments

Split a Data Frame into its Forms — splitForms

<dl>

<dt>Records</dt>
<dd><code>data.frame</code> such as one generated by <code>exportRecords</code> or
<code>exportRecordsTyped</code></dd>


<dt>rcon</dt>
<dd>A <code>redcapConnection</code> object.</dd>


<dt>envir</dt>
<dd>environment. The target environment for the resulting list
of <code>data.frame</code>s. Defaults to <code>NULL</code> which returns the a list.
Use <code>globalenv</code> to assign the global environment. Will accept a number
of the environment.</dd>


<dt>base</dt>
<dd><code>character(1)</code> giving the start of the naming scheme
for the elements of the list. By default, the names of the list will
be the form names. If this value is provided, it will follow the
format <code>base.form_name</code>.</dd>


<dt>post</dt>
<dd><code>function</code> to apply to each element of form data
after separating them, must be of signature <code>function(data, rcon)</code>.</dd>

</dl>

Split a Data Frame into its Forms

splitForms: Split a Data Frame into its Forms

Description

Usage

Arguments

See Also

Other post-processing functions

Examples