prepUserImportData

Prepares a data frame for import via the API. Allows for 
 data to be passed in either the raw format or the labelled data 
 received from <code>exportUsers</code>.

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

prepUserImportData function

<dl><dt>data</dt>
<dd><code>data.frame</code> that has the structure of 
<code>redcapAPI:::REDCAP_USER_STRUCTURE</code>. It may also have additional 
columns for the form and export access of each of the instruments.</dd>
<dt>rcon</dt>
<dd><code>redcapConnection</code>. Used to determine the instruments
in the project.</dd>
<dt>consolidate</dt>
<dd><code>logical(1)</code> If <code>TRUE</code>, the form and data 
export access values will be read from the expanded columns. Otherwise, 
the consolidated values (as provided by the API export) are utilized.</dd></dl>

Arguments

Prepare User Data for Import — prepUserImportData

<dl>

<dt>data</dt>
<dd><code>data.frame</code> that has the structure of 
<code>redcapAPI:::REDCAP_USER_STRUCTURE</code>. It may also have additional 
columns for the form and export access of each of the instruments.</dd>


<dt>rcon</dt>
<dd><code>redcapConnection</code>. Used to determine the instruments
in the project.</dd>


<dt>consolidate</dt>
<dd><code>logical(1)</code> If <code>TRUE</code>, the form and data 
export access values will be read from the expanded columns. Otherwise, 
the consolidated values (as provided by the API export) are utilized.</dd>

</dl>

Prepare User Data for Import

prepUserImportData: Prepare User Data for Import

Description

Usage

Arguments