Export Meta Data from a REDCap Database

Share:

Description

Retrieves the meta data for a REDcap database, including field names, labels, types, formulas, etc. This file can be used to parse levels of factors, apply labels, and other data management tasks once the data are retrieved

Usage

1
2
3
4
5
6
7
exportMetaData(rcon, ...)

## S3 method for class 'redcapDbConnection'
exportMetaData(rcon, ...)

## S3 method for class 'redcapApiConnection'
exportMetaData(rcon, ...)

Arguments

rcon

A REDCap connection object as generated by redcapConnection.

...

Arguments to be passed to other methods.

Details

A record of this export is placed in the REDCap logging page, but the file that is exported is not stored in the database.

Author(s)

Jeffrey Horner

References

This functionality were originally developed by Jeffrey Horner in the redcap package. https://github.com/vubiostat/redcap

Please refer to your institution's API documentation.

Additional details on API parameters are found on the package wiki at https://github.com/nutterb/redcapAPI/wiki/REDCap-API-Parameters

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
## Not run: 
#*** Note: I cannot provide working examples without
#*** compromising security.  Instead, I will try to
#*** offer up sample code with the matching results

#*** Create the connection object
rcon <- redcapConnection(url=[YOUR_REDCAP_URL], token=[API_TOKEN])

exportMetaData(rcon)

## End(Not run)