camr_download_redcap: Download Data From a REDCap Project
In rettopnivek/camrprojects: Portable Functions for R Projects at CAM-MGH
camr_download_redcap R Documentation
Download Data From a REDCap Project
Description
Function to download data from a REDCap
Project and create a list of outputs.
Usage
camr_download_redcap(chr_rc_uri = "", chr_rc_token = "", lgl_raw = TRUE)
camr_redcap_download(...)
Arguments
chr_rc_uri
A character string, the URL
to use for the httr::POST function.
chr_rc_token
A character string, the
user's API token for the specified REDCap
project.
lgl_raw
Optional. Download data in raw format.
Defaults to TRUE.
Value
A list consisting of...
'description' String. Explains the project from
which the data was downloaded.
'database'List. Information regarding the REDCap
project.
'data' Dataframe. All REDCap data with one
datapoint per row.
'metadata' Dataframe. REDCap data dictionary.
'form_event_map' Dataframe. Mappings between
REDCap events and instruments administered at each.
This will be returned for longitudinal databases only.
rettopnivek/camrprojects documentation built on March 26, 2024, 9:17 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| camr_download_redcap | R Documentation |
Download Data From a REDCap Project
Description
Function to download data from a REDCap Project and create a list of outputs.
Usage
camr_download_redcap(chr_rc_uri = "", chr_rc_token = "", lgl_raw = TRUE)
camr_redcap_download(...)
Arguments
chr_rc_uri |
A character string, the URL
to use for the |
chr_rc_token |
A character string, the user's API token for the specified REDCap project. |
lgl_raw |
Optional. Download data in raw format. Defaults to TRUE. |
Value
A list consisting of...
'description' String. Explains the project from which the data was downloaded.
'database'List. Information regarding the REDCap project.
'data' Dataframe. All REDCap data with one datapoint per row.
'metadata' Dataframe. REDCap data dictionary.
'form_event_map' Dataframe. Mappings between REDCap events and instruments administered at each. This will be returned for longitudinal databases only.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.