GetBulkRedcapData: Bulk download of REDCap data

In smockin/RedcapData: Data management utility support for REDCap repositories

Bulk download of REDCap data

Description

Download data from a REDCap repository using the REDCap api in bulk.

Usage

get_redcap_data(api, token, content = "record", local = TRUE,
  forms = NULL, fields = NULL, ids_to_pull = NULL)

Arguments

api	The REDCap instance's api location. Just append /api/ to the instance's url.
token	The secret token for the project. Check the API page in REDCap. Must have api rights to access this.
content	What to pull. Currently only 'record' and 'metadata' are supported.
local	Whether the REDCap instance is local.
forms	A character vector of the list of forms to pull data from.
fields	A character vector of the specific fields to pull data from.
ids_to_pull	A character vector of the specific record itentifiers to pull data from.

Details

A simulation of the posting of a form to the api is done and a connection is obtained.

This connection is then used to read the data from REDCap into R.

This is done in bulk. In the case of network latency or big data get_chunked_redcap_data would be a better alternative for more responsiveness.

Value

A data frame with the REDCap repo's data.

See Also

Redcap

Other Data Input: get_chunked_redcap_data

smockin/RedcapData documentation built on Feb. 2, 2023, 3:19 a.m.