Home

Welcome to the redcapAPI wiki!

The redcapAPI package is intended to help you access data from your REDCap projects. The focus of this package is to make data accessible and analysis ready as quickly as possible. Features include:

• Applying field labels to the data
• Converting categorical variables to factors
• Converting dates objects to POSIXct classes
• Converting times to times classes (using the chron package)
• Extracting subsets of fields, forms, and events
• Extracting survey metadata and data access groups

The available API actions are:

• Export records from REDCap
• Import records to REDCap
• Export the data dictionary (meta data)
• Export the users rights and permissions
• Export instruments, events, arms, and form mappings
• Export files from records in a project
• Import files to records in a project

The redcapAPI package operates through the Application Programming Interface (API) that a REDCap instance provides.

REDCap is continually releasing new versions. If ones institutions version is far enough behind, all features may not be available.

Thanks

A special thanks to Jeffrey Horner for creating this package.

A special thanks to Benjamin Nutter for developing it out and maintaining for many years (and writing most of the Wiki pages and documentation).