exportBulkRecords

Exports records from multiple REDCap Databases using
multiple calls to <code>exportRecordsTyped</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

exportBulkRecords function

<dl><dt>rcon</dt>
<dd>A named list of REDCap connection object as created by <code>redcapConnection</code>.</dd>
<dt>forms</dt>
<dd>A named list that is a subset of rcon's names. A specified <code>rcon</code>
will provide a list of forms for repeated calls to <code>exportRecordsType</code>.
If a connection reference is missing it will default to all forms. To override
this default specify a connection's forms with NA to just get all
data.</dd>
<dt>envir</dt>
<dd>A environment to write the resulting Records in as variables
given by their name in rcon or if from a form their rcon named pasted to 
their form name joined by <code>sep</code>. If not specified the function
will return a named list with the results. Will accept a number of the
environment.</dd>
<dt>sep</dt>
<dd>A character string to use when joining the rcon name to the form name
for storing variables.</dd>
<dt>post</dt>
<dd>A function that will run on all returned sets of Records.</dd>
<dt>...</dt>
<dd>Any additional variables to pass to <code>exportRecordsTyped</code>.</dd></dl>

Arguments

A helper function to export multiple records and forms using
a single call. — exportBulkRecords

<dl>

<dt>rcon</dt>
<dd>A named list of REDCap connection object as created by <code>redcapConnection</code>.</dd>


<dt>forms</dt>
<dd>A named list that is a subset of rcon's names. A specified <code>rcon</code>
will provide a list of forms for repeated calls to <code>exportRecordsType</code>.
If a connection reference is missing it will default to all forms. To override
this default specify a connection's forms with NA to just get all
data.</dd>


<dt>envir</dt>
<dd>A environment to write the resulting Records in as variables
given by their name in rcon or if from a form their rcon named pasted to 
their form name joined by <code>sep</code>. If not specified the function
will return a named list with the results. Will accept a number of the
environment.</dd>


<dt>sep</dt>
<dd>A character string to use when joining the rcon name to the form name
for storing variables.</dd>


<dt>post</dt>
<dd>A function that will run on all returned sets of Records.</dd>


<dt>...</dt>
<dd>Any additional variables to pass to <code>exportRecordsTyped</code>.</dd>

</dl>

A helper function to export multiple records and forms using
a single call.

exportBulkRecords: A helper function to export multiple records and forms using a single call.

Description

Usage

Value

Arguments