redcapAPI: R Interface to REDCap
Version 1.3

Access data stored in REDCap databases using the Application Programming Interface (API). REDCap (Research Electronic Data CAPture) is a web application for building and managing online surveys and databases developed at Vanderbilt University. The API allows users to access data and project meta data (such as the data dictionary) from the web programmatically. The redcapAPI package facilitates the process of accessing data with options to prepare an analysis-ready data set consistent with the definitions in a database's data dictionary.

AuthorBenjamin Nutter. Initiated by Jeffrey Horner and Will Gray with contributions from Jeremy Stephens, and Will Beasley
Date of publication2015-03-14 09:35:09
MaintainerStephen Lane <stephen.lane@barwonhealth.org.au>
LicenseGPL-2
Version1.3
URL https://github.com/nutterb/redcapAPI/wiki https://github.com/nutterb/redcapAPI http://project-redcap.org
Package repositoryView on CRAN
InstallationInstall the latest version of this package by entering the following in R:
install.packages("redcapAPI")

Getting started

README.md

Popular man pages

allocationTable: Allocation Tables for the Randomization Module
exportRecords: Export Records from a REDCap Database
exportReports: Export Reports from a REDCap Database
exportUsers: Export the Users for a Project
importRecords: Import Records to a REDCap Database
redcapAPI: Access data, meta data, and files from REDCap using the API
redcapConnection: Connect to a REDCap Database
See all...

All man pages Function index File listing

Man pages

allocationTable: Allocation Tables for the Randomization Module
apiCall: Execute a Call to the REDCap API
deleteFiles: Delete a File attached to a Record
exportArms: Exports the Arms for a Project
exportEvents: Export the Events for a Project
exportFiles: Exports a File attached to a Record
exportInstruments: Export Instrument names
exportMappings: Exports the Event-Form Mappings for a Project
exportMetaData: Export Meta Data from a REDCap Database
exportRecords: Export Records from a REDCap Database
exportReports: Export Reports from a REDCap Database
exportUsers: Export the Users for a Project
exportVersion: Exports the REDCap Version Number
fieldToVar: Convert a REDCap Data Field to an R Vector
importFiles: Imports a File to REDCap to Attach to a Record
importRecords: Import Records to a REDCap Database
parseBranchingLogic: Parse Branching Logic
recodeCheck: Change labelling of 'checkbox' variables
redcapAPI: Access data, meta data, and files from REDCap using the API
redcapConnection: Connect to a REDCap Database
redcapFactorFlip: Convert REDCap factors between labelled and coded
redcapProjectInfo: Export a Project's Supplemental Information
syncUnderscoreCodings: Sychronize coding of checkbox variables between meta data and...
validateImport: Validate Data Frames for Import

Functions

allocationTable Man page Source code
allocationTable.redcapApiConnection Man page Source code
allocationTable.redcapDbConnection Man page Source code
allocationTable_offline Man page Source code
apiCall Man page Source code
compareRedcapVersion Source code
deleteFiles Man page Source code
deleteFiles.redcapApiConnection Man page Source code
deleteFiles.redcapDbConnection Man page Source code
exportArms Man page Source code
exportArms.redcapApiConnection Man page Source code
exportArms.redcapDbConnection Man page Source code
exportEvents Man page Source code
exportEvents.redcapApiConnection Man page Source code
exportEvents.redcapDbConnection Man page Source code
exportFiles Man page Source code
exportFiles.redcapApiConnection Man page Source code
exportFiles.redcapDbConnection Man page Source code
exportInstruments Man page Source code
exportInstruments.redcapApiConnection Man page Source code
exportInstruments.redcapDbConnection Man page Source code
exportMappings Man page Source code
exportMappings.redcapApiConnection Man page Source code
exportMappings.redcapDbConnection Man page Source code
exportMetaData Man page Source code
exportMetaData.redcapApiConnection Man page Source code
exportMetaData.redcapDbConnection Man page Source code
exportRecords Man page Source code
exportRecords.redcapApiConnection Man page Source code
exportRecords.redcapDbConnection Man page Source code
exportRecords_offline Man page Source code
exportReports Man page Source code
exportReports.redcapApiConnection Man page Source code
exportReports.redcapDbConnection Man page Source code
exportUsers Man page Source code
exportUsers.redcapApiConnection Man page Source code
exportUsers.redcapDbConnection Man page Source code
exportVersion Man page Source code
exportVersion.redcapApiConnection Man page Source code
exportVersion.redcapDbConnection Man page Source code
fieldToVar Man page Source code
importFiles Man page Source code
importFiles.redcapApiConnection Man page Source code
importFiles.redcapDbConnection Man page Source code
importRecords Man page Source code
importRecords.redcapApiConnection Man page Source code
importRecords.redcapDbConnection Man page Source code
onLoad Source code
onUnload Source code
parseBranchingLogic Man page Source code
queryRecords Man page Source code
recodeCheck Man page Source code
redcapAPI Man page
redcapAPI-package Man page
redcapConnection Man page Source code
redcapFactorFlip Man page Source code
redcapProjectInfo Man page Source code
redcapProjectInfo.redcapApiConnection Man page Source code
redcapProjectInfo.redcapDbConnection Man page Source code
syncUnderscoreCodings Man page Source code
validateImport Man page Source code

Files

inst
inst/CITATION
src
src/Rinit.c
NAMESPACE
NEWS
R
R/exportInstruments.R
R/deleteFiles.R
R/importRecords.R
R/compareRedcapVersion.R
R/validateImport.R
R/redcapConnection.R
R/importFiles.R
R/redcapProjectInfo.R
R/exportMappings.R
R/exportEvents.R
R/parseBranchingLogic.R
R/exportArms.R
R/recodeCheck.R
R/exportMetaData.R
R/redcapFactorFlip.R
R/fieldToVar.R
R/syncUnderscoreCodings.R
R/redcapAPI-pkg.R
R/exportUsers.R
R/exportFiles.R
R/allocationTable.R
R/exportReports.R
R/exportRecords.R
R/apiCall.R
R/zzz.R
R/allocationTable_offline.R
R/exportRecords_offline.R
R/exportVersion.R
README.md
MD5
DESCRIPTION
man
man/deleteFiles.Rd
man/redcapProjectInfo.Rd
man/exportVersion.Rd
man/exportFiles.Rd
man/exportRecords.Rd
man/exportReports.Rd
man/validateImport.Rd
man/exportUsers.Rd
man/redcapAPI.Rd
man/redcapFactorFlip.Rd
man/allocationTable.Rd
man/syncUnderscoreCodings.Rd
man/apiCall.Rd
man/importFiles.Rd
man/exportInstruments.Rd
man/redcapConnection.Rd
man/parseBranchingLogic.Rd
man/fieldToVar.Rd
man/exportMappings.Rd
man/importRecords.Rd
man/exportArms.Rd
man/recodeCheck.Rd
man/exportEvents.Rd
man/exportMetaData.Rd
redcapAPI documentation built on May 19, 2017, 4:52 p.m.

Questions? Problems? Suggestions? Tweet to @rdrrHQ or email at ian@mutexlabs.com.

Please suggest features or report bugs in the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.