Learn R Programming
⚠️There's a newer version (2.10.0) of this package.Take me there.

redcapAPI

NOTE: Ownership transfer of this package to VUMC Biostatistics is complete. Existing tickets in the older git repo will be transitioned over the next couple months.

The research community owes a big thanks to Benjamin Nutter for his years of service keeping this package current.

The package redcapAPI is an R interface to REDCap (http://www.project-redcap.org/), originally created by Jeffrey Horner.

Please read the documentation on your institutions REDCap installation.

Issues may be reported at Issues

This package was developed under REDCap Version 13.2.4. Institutions can be a little behind on updating REDCap and so some features of the API may not always work.

Copy Link

Version

Install

install.packages('redcapAPI')

Monthly Downloads

1,110

Version

2.5.0

License

GPL-2

Issues

12

Pull Requests

4

Stars

22

Forks

27

Maintainer

Shawn Garbett

Last Published

March 24th, 2023

Functions in redcapAPI (2.5.0)

exportEvents

Export the Events for a Project
exportFiles

Exports a File attached to a Record
exportLogging

Export Logging Records
exportMetaData

Export Meta Data from a REDCap Database
exportNextRecordName

Generate Next Record Name from a REDCap Database
exportInstruments

Exports the REDCap Instruments
exportBundle

Perform a bundle of API calls.
exportFieldNames

Export the Export Field Names for a Project
exportArms

Export the Arms for a Project
exportPdf

Export PDF file of Data Collection Instruments (either as blank or with data)
exportSurveyParticipants

Exports details of participants for a given survey
exportVersion

Exports the REDCap Version Number
exportProjectInformation

Exports the Project Information
exportMappings

Exports the Event-Form Mappings for a Project
exportUsers

Export the Users for a Project
genericApiCall

Generic Interface the REDCap API.
fieldToVar

Convert a REDCap Data Field to an R Vector
exportRecords

Export Records from a REDCap Database
importRecords

Import Records to a REDCap Database
parseBranchingLogic

Parse Branching Logic
redcapAPI

Access data, meta data, and files from REDCap using the API
fieldChoiceMapping

Splits a Field Choice Mapping Into a Two Column Matrix
exportReports

Export Reports from a REDCap Database
makeApiCall

Make REDCap API Calls
importArms

Import Study Arm Names
importFiles

Imports a File to REDCap to Attach to a Record
recodeCheck

Change labelling of checkbox variables
vectorToApiBodyList

Convert R Vector To List for the API Call Body
redcapConnection

Connect to a REDCap Database
redcapFactorFlip

Convert REDCap factors between labelled and coded
redcap_error

Handle Errors from the REDCap API
syncUnderscoreCodings

Sychronize coding of checkbox variables between meta data and records field names.
validateImport

Validate Data Frames for Import
missingSummary

Report of Missing Values
massert

Conduct Multiple Assertions
deleteFiles

Delete a File attached to a Record
Extraction

Extraction and Assignment for redcapFactors
deleteArms

Delete Arms From a Project
cleanseMetaData

Clean Meta Data of UTF Characters
constants

Constants for Use in the redcapAPI Package
deprecated_redcapProjectInfo

Deprecated Functions
apiCall

Execute a Call to the REDCap API
checkbox_suffixes

Checkbox Suffixes
deleteRecords

Delete Records From a Project
allocationTable

Allocation Tables for the Randomization Module