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
POSIXctclasses - Converting times to
timesclasses (using thechronpackage) - 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
Currently, the redcapAPI package operates through the Application Programming Interface (API), but the infrastructure exists that it could be extended to be accessed using a database connection. Such a connection would allow you to query the data from REDCap instead of downloading a complete project.
The version of REDCap I was using while developing this package was 5.8.2. Some features have been introduced in later versions. Where possible, I have tried to make the redcapAPI package function independently of what version of REDCap is available. This is not, however, always possible, and so depending on your version of REDCap, you may not be able to use every function.