redcapAPI2.9.1 package

Interface to 'REDCap'

armsMethods

Export, Import, and Delete Arms from a Project

makeApiCall

Make REDCap API Calls

recordsMethods

Export Records and Reports

recordsTypedMethods

Export Records or Reports From a Project

syncUnderscoreCodings

Synchronize coding of checkbox variables between meta data and records...

allocationTable

Generate Allocation Tables for the Randomization Module

assembleCodebook

Assemble Codebook From the Data Dictionary

attributeAssignment

Helper Functions for exportRecordsType Attributes

changedRecords

returns a list of record IDs changed (adds, updates, deletes)

checkbox_suffixes

Checkbox Suffixes

constructLinkToRedcapForm

Construct a Link to a REDCap Form

unlockREDCap

Open REDCap connections using cryptolocker for storage of API_KEYs.

userMethods

Export, Import, or Delete Users and User Permissisons

createFileRepositoryFolder

Create a Folder in the File Repository

createRedcapProject

Create REDCap Project

dagAssignmentMethods

Export and Import Users Assigned to Data Access Groups

dagMethods

Export, Import, Delete Data Access Groups from a Project

deleteRecords

Delete Records from a Project

deprecated_redcapProjectInfo

Deprecated Functions

dropRepeatingNA

Drop Row Where Repeat Instrument Is NA

eventsMethods

Export, Import, and Delete Event Settings

exportBulkRecords

A helper function to export multiple records and forms using a single ...

exportBundle

Perform a bundle of API calls.

exportDataQuality

A helper function to export data queries from the Data Quality REDCap ...

exportExternalCoding

Export Codebook Mappings for Fields with External Dependencies

exportFieldNames

Export the Complete Field Names for a REDCap Project

exportFileRepositoryListing

Export a Listing of Folders and Files in the File Repository

exportFilesMultiple

Export Multiple Files From a Project

exportInstruments

Export Instruments Defined in a Project

exportLogging

Export Logging Records

exportPdf

Export PDF file of Data Collection Instruments

exportProjectXml

Export Entire Project as REDCap XML File

exportVersion

Export the REDCap Version Number

Extraction

Extraction and Assignment for redcapFactors

fieldCastingFunctions

Functions for Casting Fields After Export (Post Processing)

fieldChoiceMapping

Split a Field Choice Mapping Into a Two Column Matrix

fieldToVar

Convert a REDCap Data Field to an R Vector

fieldValidationAndCasting

Helper functions for exportRecordsTyped Validation and Casting

fileMethods

Export, Import, or Delete Files to a Field in a REDCap Project

fileRepositoryMethods

Export, Import, or Delete Multiple Files from the File Repository

fileRepositoryPath

Reconstruct the file repository path

filterEmptyRow

Remove Rows Containing Only Missing Values

fromFileRepositoryMethods

Export, Import, and Delete Individual Files from the File Repository

getProjectIdFields

Return a vector of the Project ID Fields

importFileToRecord

Import a File With Option to Create A Record to Receive the File

importRecords

Import Records to a Project

invalidSummary

Helper functions for formatting validation failure report

isZeroCodedCheckField

Identify Check Fields with a Zero Coded Option

mappingMethods

Export and Import Instrument-Event Mappings

massert

Conduct Multiple Assertions

metaDataMethods

Export and Import the Project Meta Data (Data Dictionary)

missingSummary

Report of Missing Values

parseBranchingLogic

Parse Branching Logic

prepUserImportData

Prepare User Data for Import

preserveProject

Preserve Project Data Locally

projectInformationMethods

Export and Import Project Settings

purgeRestoreProject

Purge and Restore Project Data

recodeCheck

Change labeling of checkbox variables

reconstituteFileFromExport

Save a File to a Local Directory from a Response

recordsManagementMethods

Export Next Record Name or Rename a Record

redcapAPI

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

redcapConnection

Connect to a REDCap Database

redcapDataStructures

REDCap Data Structures

redcapError

Handle Errors from the REDCap API

redcapFactorFlip

Convert REDCap factors between labeled and coded

repeatingInstrumentMethods

Export or Import Repeating Instrument and Events Settings

reviewInvalidRecords

Review Invalid Records Following Field Validation

splitForms

Split a Data Frame into its Forms

stringCleanup

Remove Undesired Characters From Strings

surveyMethods

Export Survey Participant Information

switchDag

Switch Data Access Group Assignment for the Current User

userRoleAssignmentMethods

Export or Import User-Role Assignments

userRoleMethods

Export, Import, or Delete User Roles in a Project

validateImport

Validate Data Frames for Import

vectorToApiBodyList

Convert R Vector To List for the API Call Body

widerRepeated

Transform Data Into Wide Format

writeDataForImport

Prepare a Data Frame for Import Through the API

Access data stored in 'REDCap' databases using the Application Programming Interface (API). 'REDCap' (Research Electronic Data CAPture; <https://projectredcap.org>, Harris, et al. (2009) <doi:10.1016/j.jbi.2008.08.010>, Harris, et al. (2019) <doi:10.1016/j.jbi.2019.103208>) 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.

  • Maintainer: Shawn Garbett
  • License: GPL-2
  • Last published: 2024-05-16