Learn R Programming

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

redcapAPI

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

Please read the documentation on your institutions REDCap installation.

Issues may be reported at https://github.com/nutterb/redcapAPI/issues

Please consider contributing tips and clarifications to the package wiki at https://github.com/nutterb/redcapAPI/wiki

This package was developed under REDCap Version 5.8.2. My institution is usually a little behind on updating REDCap and so some features of the API may not always be available.

The redcapDbConnection methods are underdeveloped as I don't personally have access to the REDCap database (and so am unable to test features). If you have that kind of access, feel free to develop the redcapDbConnection methods.

Supplemental Gists

Generate a Report of Fields with Missing Values in a REDCap Database Using the redcapAPI package (includes a version for "offline" use).

Copy Link

Version

Install

install.packages('redcapAPI')

Monthly Downloads

917

Version

2.2

License

GPL-2

Issues

Pull Requests

Stars

Forks

Repository

https://github.com/nutterb/redcapAPI/wiki

Homepage

https://github.com/nutterb/redcapAPI

Maintainer

Benjamin Nutter

Last Published

August 1st, 2018

Functions in redcapAPI (2.2)

Export the Events for a Project

exportNextRecordName

Generate Next Record Name from a REDCap Database

Perform a bundle of API calls.

Generic Interface the REDCap API.

exportProjectInformation

Exports the Project Information

Import Study Arm Names

Export Records from a REDCap Database

exportFieldNames

Export the Export Field Names for a Project

Exports a File attached to a Record

exportInstruments

Exports the REDCap Instruments

Export the Users for a Project

Exports the Event-Form Mappings for a Project

Export Reports from a REDCap Database

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

Exports the REDCap Version Number

Convert a REDCap Data Field to an R Vector

Handle Errors from the REDCap API

syncUnderscoreCodings

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

Change labelling of checkbox variables

Conduct Multiple Assertions

parseBranchingLogic

Parse Branching Logic

Validate Data Frames for Import

redcapConnection

Connect to a REDCap Database

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

redcapFactorFlip

Convert REDCap factors between labelled and coded

Export Meta Data from a REDCap Database

Imports a File to REDCap to Attach to a Record

Import Records to a REDCap Database

Extraction and Assignment for redcapFactors

allocationTable

Allocation Tables for the Randomization Module

Delete a File attached to a Record

Export the Arms for a Project

deprecated_redcapProjectInfo

Deprecated Functions

Execute a Call to the REDCap API

checkbox_suffixes

Checkbox Suffixes

cleanseMetaData

Clean Meta Data of UTF Characters

Delete Arms From a Project