Interface to 'REDCap'


[Up] [Top]

Documentation for package ‘redcapAPI’ version 2.5.0

Help Pages

allocationTable Allocation Tables for the Randomization Module
allocationTable.redcapApiConnection Allocation Tables for the Randomization Module
allocationTable_offline Allocation Tables for the Randomization Module
apiCall Execute a Call to the REDCap API
checkbox_suffixes Checkbox Suffixes
cleanseMetaData Clean Meta Data of UTF Characters
constants Constants for Use in the redcapAPI Package
deleteArms Delete Arms From a Project
deleteArms.redcapApiConnection Delete Arms From a Project
deleteFiles Delete a File attached to a Record
deleteFiles.redcapApiConnection Delete a File attached to a Record
deleteRecords Delete Records From a Project
deleteRecords.redcapApiConnection Delete Records From a Project
deprecated_redcapProjectInfo Deprecated Functions
exportArms Export the Arms for a Project
exportArms.redcapApiConnection Export the Arms for a Project
exportBundle Perform a bundle of API calls.
exportBundle.redcapApiConnection Perform a bundle of API calls.
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
exportFiles Exports a File attached to a Record
exportFiles.redcapApiConnection Exports a File attached to a Record
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
exportRecords_offline Export Records from a REDCap Database
exportReports Export Reports from a REDCap Database
exportReports.redcapApiConnection Export Reports from a REDCap Database
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
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
genericApiCall Generic Interface the REDCap API.
genericApiCall.redcapApiConnection Generic Interface the REDCap API.
importArms Import Study Arm Names
importArms.redcapApiConnection Import Study Arm Names
importFiles Imports a File to REDCap to Attach to a Record
importFiles.redcapApiConnection Imports a File to REDCap to Attach to a Record
importRecords Import Records to a REDCap Database
importRecords.redcapApiConnection Import Records to a REDCap Database
makeApiCall Make REDCap API Calls
makeChoices Allocation Tables for the Randomization Module
massert Conduct Multiple Assertions
missingSummary Report of Missing Values
missingSummary.redcapApiConnection Report of Missing Values
missingSummary_offline Report of Missing Values
parseBranchingLogic Parse Branching Logic
print.redcapApiConnection Connect to a REDCap Database
print.redcapFactor Extraction and Assignment for 'redcapFactor's
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 Deprecated Functions
redcapProjectInfo.redcapApiConnection Deprecated Functions
redcap_error Handle Errors from the REDCap API
REDCAP_SYSTEM_FIELDS Constants for Use in the redcapAPI Package
syncUnderscoreCodings Sychronize coding of checkbox variables between meta data and records field names.
validateImport Validate Data Frames for Import
vectorToApiBodyList Convert R Vector To List for the API Call Body
[.redcapFactor Extraction and Assignment for 'redcapFactor's