GetChunkedRedcapData: Download REDCap data in chunks

Description Usage Arguments Details See Also

Description

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

Data and metadata are stored in the calling environment.

Usage

1
2
3
get_chunked_redcap_data(api, token, local = TRUE, chunksize = 100,
  forms = NULL, fields = NULL, ids_to_pull = NULL,
  dataset_name = "records", metadataset_name = "meta")

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.

local

Whether the REDCap instance is local.

chunksize

The size of the chunks to be pulled at a time.

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 from.

dataset_name

Name of the resultant dataset

metadataset_name

Name of the resultant metadata

Details

The record identifiers are chunked and then data is is pulled for those specific records.

The result is then combined into one data table.

This might be handy in the case of network latency or when the data is large.

This is just a convenient wrapper round the get_redcap_data function.

In cases of strong bandwidth or small data sizes, just use get_redcap_data.

See Also

get_chunks, Redcap

Other Data Input: get_redcap_data


bonmac/RedcapData documentation built on May 11, 2017, 1:34 p.m.