Interface to 'REDCap'
![[R logo]](../../../doc/html/Rlogo.svg)
![[Up]](../../../doc/html/left.jpg)
![[Top]](../../../doc/html/up.jpg)
Documentation for package ‘redcapAPI’ version 2.7.4
Help Pages
A C D E F G I M N O P R S U V W misc
-- A --
| allocationTable | Generate Allocation Tables for the Randomization Module |
| allocationTable.redcapApiConnection | Generate Allocation Tables for the Randomization Module |
| allocationTable_offline | Generate Allocation Tables for the Randomization Module |
-- C --
| castCheckCode | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castChecked | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castCheckForImport | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castCheckLabel | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castCode | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castDpCharacter | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castDpNumeric | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castForImport | Functions for Casting Fields After Export (Post Processing) |
| castLabel | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castRaw | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castTimeHHMM | Helper functions for 'exportRecordsTyped' Validation and Casting |
| castTimeMMSS | Helper functions for 'exportRecordsTyped' Validation and Casting |
| checkbox_suffixes | Checkbox Suffixes |
| cleanseMetaData | Clean Meta Data of UTF Characters |
| createFileRepositoryFolder | Create a Folder in the File Repository |
| createFileRepositoryFolder.redcapApiConnection | Create a Folder in the File Repository |
-- D --
| deleteArms | Delete Arms From a Project |
| deleteArms.redcapApiConnection | Delete Arms From a Project |
| deleteEvents | Delete Events from a Project |
| deleteFileRepository | Delete All Files from the File Repository |
| deleteFileRepository.redcapApiConnection | Delete All Files from the File Repository |
| deleteFiles | Delete a File attached to a Record |
| deleteFiles.redcapApiConnection | Delete a File attached to a Record |
| deleteFromFileRepository | Delete a Single File from the File Repository |
| deleteFromFileRepository.redcapApiConnection | Delete a Single File from the File Repository |
| deleteRecords | Delete Records From a Project |
| deleteRecords.redcapApiConnection | Delete Records From a Project |
| deprecated_redcapProjectInfo | Deprecated Functions |
| dropRepeatingNA | Drop Row Where Repeat Instrument Is NA |
-- E --
| exportArms | Export the Arms for a Project |
| exportArms.redcapApiConnection | Export the Arms for a Project |
| exportBulkRecords | A helper function to export multiple records and forms using a single call. |
| exportBundle | Perform a bundle of API calls. |
| exportBundle.redcapApiConnection | Perform a bundle of API calls. |
| exportDags | Export Data Access Groups |
| exportDags.redcapApiConnection | Export Data Access Groups |
| exportEvents | Export the Events for a Project |
| exportEvents.redcapApiConnection | Export the Events for a Project |
| exportFieldNames | Export the Export Field Names for a Project |
| exportFieldNames.redcapApiConnection | Export the Export Field Names for a Project |
| exportFileRepository | Export All Files From a Directory in the File Repository |
| exportFileRepository.redcapApiConnection | Export All Files From a Directory in the File Repository |
| exportFileRepositoryListing | Export a Listing of Folders and Files in the File Repository |
| exportFileRepositoryListing.redcapApiConnection | Export a Listing of Folders and Files in the File Repository |
| exportFiles | Exports a File attached to a Record |
| exportFiles.redcapApiConnection | Exports a File attached to a Record |
| exportFromFileRepository | Export a File from the File Repository |
| exportFromFileRepository.redcapApiConnection | Export a File from the File Repository |
| exportInstruments | Exports the REDCap Instruments |
| exportInstruments.redcapApiConnection | Exports the REDCap Instruments |
| exportLogging | Export Logging Records |
| exportLogging.redcapApiConnection | Export Logging Records |
| exportMappings | Exports the Event-Form Mappings for a Project |
| exportMappings.redcapApiConnection | Exports the Event-Form Mappings for a Project |
| exportMetaData | Export Meta Data from a REDCap Database |
| exportMetaData.redcapApiConnection | Export Meta Data from a REDCap Database |
| exportNextRecordName | Generate Next Record Name from a REDCap Database |
| exportNextRecordName.redcapApiConnection | Generate Next Record Name from a REDCap Database |
| exportPdf | Export PDF file of Data Collection Instruments (either as blank or with data) |
| exportPdf.redcapApiConnection | Export PDF file of Data Collection Instruments (either as blank or with data) |
| exportProjectInformation | Exports the Project Information |
| exportProjectInformation.redcapApiConnection | Exports the Project Information |
| exportRecords | Export Records from a REDCap Database |
| exportRecords.redcapApiConnection | Export Records from a REDCap Database |
| exportRecordsTyped | A replacement for 'exportRecords' with full inversion of control over type casting. |
| exportRecordsTyped.redcapApiConnection | A replacement for 'exportRecords' with full inversion of control over type casting. |
| exportRecordsTyped.redcapOfflineConnection | A replacement for 'exportRecords' with full inversion of control over type casting. |
| exportRecords_offline | Export Records from a REDCap Database |
| exportRepeatingInstrumentsEvents | Export Repeating Instruments and Events Settings |
| exportRepeatingInstrumentsEvents.redcapApiConnection | Export Repeating Instruments and Events Settings |
| exportReports | Export Reports from a REDCap Database |
| exportReports.redcapApiConnection | Export Reports from a REDCap Database |
| exportReportsTyped | Export a Report from a REDCap Project |
| exportReportsTyped.redcapApiConnection | Export a Report from a REDCap Project |
| exportSurveyParticipants | Exports details of participants for a given survey |
| exportSurveyParticipants.redcapApiConnection | Exports details of participants for a given survey |
| exportUsers | Export the Users for a Project |
| exportUsers.redcapApiConnection | Export the Users for a Project |
| exportVersion | Exports the REDCap Version Number |
| exportVersion.redcapApiConnection | Exports the REDCap Version Number |
| Extraction | Extraction and Assignment for 'redcapFactor's |
-- F --
| fieldCastingFunctions | Functions for Casting Fields After Export (Post Processing) |
| fieldChoiceMapping | Splits a Field Choice Mapping Into a Two Column Matrix |
| fieldChoiceMapping.character | Splits a Field Choice Mapping Into a Two Column Matrix |
| fieldChoiceMapping.redcapApiConnection | Splits 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 |
| fileRepositoryPath | Reconstruct the file repository path |
| filterEmptyRow | Remove Rows Containing Only Missing Values |
| format.invalid | Helper functions for formatting validation failure report |
-- G --
| getProjectIdFields | Return a vector of the Project ID Fields |
| guessCast | Functions for Casting Fields After Export (Post Processing) |
| guessDate | Functions for Casting Fields After Export (Post Processing) |
-- I --
| importArms | Import Study Arm Names |
| importArms.redcapApiConnection | Import Study Arm Names |
| importEvents | Import Events to REDCap |
| importFileRepository | Import a Folder and its Contents to the File Repository |
| importFileRepository.redcapApiConnection | Import a Folder and its Contents to the File Repository |
| importFiles | Imports a File to REDCap to Attach to a Record |
| importFiles.redcapApiConnection | Imports a File to REDCap to Attach to a Record |
| importMappings | Import Instrument Event Mapping |
| importMappings.redcapApiConnection | Import Instrument Event Mapping |
| importMetaData | Import Meta Data (Data Dictionary) to a Project |
| importMetaData.redcapApiConnection | Import Meta Data (Data Dictionary) to a Project |
| importProjectInformation | Import Project Information |
| importProjectInformation.redcapApiConnection | Import Project Information |
| importRecords | Import Records to a REDCap Database |
| importRecords.redcapApiConnection | Import Records to a REDCap Database |
| importRepeatingInstrumentsEvents | Import Repeating Instruments and Events Settings |
| importRepeatingInstrumentsEvents.redcapApiConnection | Import Repeating Instruments and Events Settings |
| importToFileRepository | Import a Single File to the File Repository |
| importToFileRepository.redcapApiConnection | Import a Single File to the File Repository |
| isNAorBlank | Helper functions for 'exportRecordsTyped' Validation and Casting |
-- M --
| makeApiCall | Make REDCap API Calls |
| makeChoices | Generate Allocation Tables for the Randomization Module |
| massert | Conduct Multiple Assertions |
| mChoiceCast | Functions for Casting Fields After Export (Post Processing) |
| missingSummary | Report of Missing Values |
| missingSummary.redcapApiConnection | Report of Missing Values |
| missingSummary_offline | Report of Missing Values |
-- N --
| na_values | Helper functions for 'exportRecordsTyped' Validation and Casting |
-- O --
| offlineConnection | Connect to a REDCap Database |
-- P --
| parseBranchingLogic | Parse Branching Logic |
| prepUserImportData | Prepare User Data for Import |
| preserveProject | Purge and Restore Project Data |
| preserveProject.redcapApiConnection | Purge and Restore Project Data |
| print.invalid | Helper functions for formatting validation failure report |
| print.redcapApiConnection | Connect to a REDCap Database |
| print.redcapFactor | Extraction and Assignment for 'redcapFactor's |
| print.redcapOfflineConnection | Connect to a REDCap Database |
| purgeProject | Purge and Restore Project Data |
| purgeProject.redcapApiConnection | Purge and Restore Project Data |
| purgeRestoreProject | Purge and Restore Project Data |
-- R --
| raw_cast | Helper functions for 'exportRecordsTyped' Validation and Casting |
| recastRecords | Functions for Casting Fields After Export (Post Processing) |
| recodeCheck | Change labelling of 'checkbox' variables |
| reconstituteFileFromExport | Save a File to a Local Directory from a Response |
| redcapAPI | Access data, meta data, and files from REDCap using the API |
| redcapConnection | Connect to a REDCap Database |
| redcapDataStructures | REDCap Data Structures |
| redcapFactorFlip | Convert REDCap factors between labelled and coded |
| redcapProjectInfo | Deprecated Functions |
| redcapProjectInfo.redcapApiConnection | Deprecated Functions |
| redcap_error | Handle Errors from the REDCap API |
| REDCAP_METADATA_FIELDTYPE | REDCap Data Structures |
| REDCAP_METADATA_VALIDATION_TYPE | REDCap Data Structures |
| REDCAP_REPEAT_INSTRUMENT_STRUCTURE | REDCap Data Structures |
| REDCAP_SYSTEM_FIELDS | REDCap Data Structures |
| restoreProject | Purge and Restore Project Data |
| restoreProject.list | Purge and Restore Project Data |
| restoreProject.redcapApiConnection | Purge and Restore Project Data |
-- S --
| splitForms | Split a Data Frame into its Forms |
| stringCleanup | Remove Undesired Characters From Strings |
| stripHTMLandUnicode | Helper functions for 'exportRecordsTyped' attributes |
| stripHTMLTags | Remove Undesired Characters From Strings |
| stripUnicode | Remove Undesired Characters From Strings |
| summary.invalid | Helper functions for formatting validation failure report |
| syncUnderscoreCodings | Synchronize coding of checkbox variables between meta data and records field names. |
-- U --
| unitsFieldAnnotation | Helper functions for 'exportRecordsTyped' attributes |
| unlockREDCap | Open REDCap connections using cryptolocker for storage of API_KEYs. |
-- V --
| valChoice | Helper functions for 'exportRecordsTyped' Validation and Casting |
| validateImport | Validate Data Frames for Import |
| validateRedcapData | REDCap Data Structures |
| valPhone | Helper functions for 'exportRecordsTyped' Validation and Casting |
| valRx | Helper functions for 'exportRecordsTyped' Validation and Casting |
| vectorToApiBodyList | Convert R Vector To List for the API Call Body |
-- W --
| widerRepeated | Transform Data Into Wide Format |
| writeDataForImport | Prepare a Data Frame for Import Through the API |
-- misc --
| [.redcapFactor | Extraction and Assignment for 'redcapFactor's |