Learn R Programming

redcapAPI (version 2.7.4)

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

Description

Exports records from multiple REDCap Databases using multiple calls to exportRecordsTyped

Usage

exportBulkRecords(
  rcon,
  forms = NULL,
  envir = NULL,
  sep = "_",
  post = NULL,
  ...
)

Value

Will return a named list of the resulting records if envir is NULL. Otherwise will assign them to the specified envir.

Arguments

rcon

A named list of REDCap connection object as created by redcapConnection.

forms

A named list that is a subset of rcon's names. A specified rcon will provide a list of forms for repeated calls to exportRecordsType. 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.

envir

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 sep. If not specified the function will return a named list with the results. Will accept a number of the environment.

sep

A character string to use when joining the rcon name to the form name for storing variables.

post

A function that will run on all returned sets of Records.

...

Any additional variables to pass to exportRecordsTyped.