export_core: Export Core

In REDCapExporter: Automated Construction of R Data Packages from REDCap Projects

Export Core

Description

Export Core Contents of a REDCap Project.

Usage

export_core(uri = NULL, token = NULL, format = NULL, verbose = TRUE, ...)

Arguments

uri	The URI for the REDCap API. If NULL (default) the value Sys.getenv("REDCap_API_URI") is used.
token	The API token for the project you want to export from. If NULL (default) the value Sys.getenv("REDCap_API_TOKEN") is used.
format	The format to return. If NULL (default) the value Sys.getenv("REDCap_API_format") is used.
verbose	provide messages to tell the user what is happening
...	not currently used

Value

A rcer_rccore object: a list with the project info, metadata, user table, and records, all in a "raw" format direct from the API.

Examples

# A reproducible example would require a REDCap project, accessable via an
# API token.  An example of the return from these calls are provided as data
# with this package.

# avs_raw_core <- export_core()

data(avs_raw_core)
str(avs_raw_core)

REDCapExporter documentation built on April 4, 2025, 2:29 a.m.