Package: redcapAPI 2.10.0
Shawn Garbett
redcapAPI: Interface to 'REDCap'
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.
Authors:
redcapAPI_2.10.0.tar.gz
redcapAPI_2.10.0.zip(r-4.5)redcapAPI_2.10.0.zip(r-4.4)redcapAPI_2.10.0.zip(r-4.3)
redcapAPI_2.10.0.tgz(r-4.4-any)redcapAPI_2.10.0.tgz(r-4.3-any)
redcapAPI_2.10.0.tar.gz(r-4.5-noble)redcapAPI_2.10.0.tar.gz(r-4.4-noble)
redcapAPI_2.10.0.tgz(r-4.4-emscripten)redcapAPI_2.10.0.tgz(r-4.3-emscripten)
redcapAPI.pdf |redcapAPI.html✨
redcapAPI/json (API)
NEWS
| # Install 'redcapAPI' in R: |
| install.packages('redcapAPI', repos = c('https://vubiostat.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/vubiostat/redcapapi/issues
Last updated 2 months agofrom:82a91c2565. Checks:OK: 7. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Aug 30 2024 |
| R-4.5-win | OK | Aug 30 2024 |
| R-4.5-linux | OK | Aug 30 2024 |
| R-4.4-win | OK | Aug 30 2024 |
| R-4.4-mac | OK | Aug 30 2024 |
| R-4.3-win | OK | Aug 30 2024 |
| R-4.3-mac | OK | Aug 30 2024 |
Exports:allocationTableallocationTable_offlineassembleCodebookcastCheckCodecastCheckCodeCharactercastCheckedcastCheckedCharactercastCheckForImportcastCheckLabelcastCheckLabelCharactercastCodecastCodeCharactercastDpCharactercastDpNumericcastForImportcastLabelcastLabelCharactercastLogicalcastRawcastTimeHHMMcastTimeMMSSchangedRecordscheckbox_suffixescreateFileRepositoryFoldercreateRedcapProjectdefault_cast_characterdefault_cast_no_factordeleteArmsdeleteDagsdeleteEventsdeleteFileRepositorydeleteFilesdeleteFromFileRepositorydeleteRecordsdeleteUserRolesdeleteUsersexportArmsexportBulkRecordsexportBundleexportDagsexportDataQualityexportEventsexportFieldNamesexportFileRepositoryexportFileRepositoryListingexportFilesexportFilesMultipleexportFromFileRepositoryexportInstrumentsexportLoggingexportMappingsexportMetaDataexportNextRecordNameexportProjectInformationexportProjectXmlexportRecordsexportRecords_offlineexportRecordsTypedexportRepeatingInstrumentsEventsexportReportsexportReportsTypedexportSurveyLinkexportSurveyParticipantsexportSurveyQueueLinkexportSurveyReturnCodeexportUserDagAssignmentsexportUserRoleAssignmentsexportUserRolesexportUsersexportVersionfieldChoiceMappingguessCastguessDateimportArmsimportDagsimportEventsimportFileRepositoryimportFilesimportFileToRecordimportMappingsimportMetaDataimportProjectInformationimportRecordsimportRepeatingInstrumentsEventsimportToFileRepositoryimportUserDagAssignmentsimportUserRoleAssignmentsimportUserRolesimportUsersisNAorBlankmakeApiCallmChoiceCastmissingSummarymissingSummary_offlinena_valuesofflineConnectionparseBranchingLogicprepUserImportDatapreserveProjectpurgeProjectraw_castreadPreservedProjectrecastRecordsrecodeCheckreconstituteFileFromExportREDCAP_METADATA_FIELDTYPEREDCAP_METADATA_VALIDATION_TYPEREDCAP_PROJECT_PURPOSEREDCAP_REPEAT_INSTRUMENT_STRUCTUREREDCAP_SYSTEM_FIELDSredcapConnectionredcapFactorFlipredcapProjectInforenameRecordrestoreProjectreviewInvalidRecordsskip_validationsplitFormsstripHTMLandUnicodestripHTMLTagsstripUnicodeswitchDagunitsFieldAnnotationunlockREDCapvalChoicevalPhonevalRxvalSkipvectorToApiBodyListwiderRepeated
Dependencies:askpassassertthatbackportscheckmatechroncpp11curlfilelockgenericsgetPassjsonlitekeyringlabelVectorlubridatemimeopensslR6rappdirsrstudioapisodiumsystimechangeyaml
Casting Data
Rendered fromredcapAPI-casting-data.Rnwusingutils::Sweaveon Aug 30 2024.Last update: 2023-11-13
Started: 2023-11-13
Data Validation with exportRecordsTyped
Rendered fromredcapAPI-data-validation.Rnwusingutils::Sweaveon Aug 30 2024.Last update: 2023-11-13
Started: 2023-11-13
Getting Started: Connecting to REDCap
Rendered fromredcapAPI-getting-started-connecting.Rnwusingutils::Sweaveon Aug 30 2024.Last update: 2023-11-13
Started: 2023-11-13
Missing Data Detection with exportRecordsTyped
Rendered fromredcapAPI-missing-data-detection.Rnwusingutils::Sweaveon Aug 30 2024.Last update: 2023-11-13
Started: 2023-11-13
redcapAPI Best Practices
Rendered fromredcapAPI-best-practices.Rnwusingutils::Sweaveon Aug 30 2024.Last update: 2023-06-12
Started: 2023-06-12
redcapAPI FAQ
Rendered fromredcapAPI-faq.Rnwusingutils::Sweaveon Aug 30 2024.Last update: 2024-01-08
Started: 2024-01-08
redcapAPI Offline Connections
Rendered fromredcapAPI-offline-connection.Rnwusingutils::Sweaveon Aug 30 2024.Last update: 2023-10-11
Started: 2023-10-11
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Generate Allocation Tables for the Randomization Module | allocationTable allocationTable.redcapApiConnection allocationTable_offline |
| Export, Import, and Delete Arms from a Project | armsMethods deleteArms deleteArms.redcapApiConnection exportArms exportArms.redcapApiConnection importArms importArms.redcapApiConnection |
| S3 method to turn curl response into character | as.character.response |
| Assemble Codebook From the Data Dictionary | as.list.redcapCodebook assembleCodebook assembleCodebook.redcapConnection |
| returns a list of record IDs changed (adds, updates, deletes) | changedRecords |
| Checkbox Suffixes | checkbox_suffixes |
| Construct a Link to a REDCap Form | constructLinkToRedcapForm constructLinkToRedcapForm.redcapApiConnection constructLinkToRedcapForm.redcapOfflineConnection |
| Create a Folder in the File Repository | createFileRepositoryFolder createFileRepositoryFolder.redcapApiConnection |
| Create REDCap Project | createRedcapProject createRedcapProject.redcapApiConnection |
| Export and Import Users Assigned to Data Access Groups | dagAssignmentMethods exportUserDagAssignments exportUserDagAssignments.redcapApiConnection importUserDagAssignments importUserDagAssignments.redcapApiConnection |
| Export, Import, Delete Data Access Groups from a Project | dagMethods deleteDags deleteDags.redcapApiConnection exportDags exportDags.redcapApiConnection importDags importDags.redcapApiConnection |
| Delete Records from a Project | deleteRecords deleteRecords.redcapApiConnection |
| Deprecated Functions | deprecated_redcapProjectInfo redcapProjectInfo redcapProjectInfo.redcapApiConnection |
| Drop Row Where Repeat Instrument Is NA | dropRepeatingNA |
| Export, Import, and Delete Event Settings | deleteEvents deleteEvents.redcapApiConnection eventsMethods exportEvents exportEvents.redcapApiConnection importEvents importEvents.redcapApiConnection |
| A helper function to export multiple records and forms using a single call. | exportBulkRecords |
| Perform a bundle of API calls. | exportBundle exportBundle.redcapApiConnection |
| A helper function to export data queries from the Data Quality REDCap module. | exportDataQuality |
| Export Codebook Mappings for Fields with External Dependencies | exportExternalCoding exportExternalCoding.redcapApiConnection |
| Export the Complete Field Names for a REDCap Project | exportFieldNames exportFieldNames.redcapApiConnection exportFieldNamesArgs |
| Export a Listing of Folders and Files in the File Repository | exportFileRepositoryListing exportFileRepositoryListing.redcapApiConnection |
| Export Multiple Files From a Project | exportFilesMultiple exportFilesMultiple.redcapApiConnection |
| Export Instruments Defined in a Project | exportInstruments exportInstruments.redcapApiConnection |
| Export Logging Records | exportLogging exportLogging.redcapApiConnection |
| Export PDF file of Data Collection Instruments | exportPdf exportPdf.redcapApiConnection |
| Export Entire Project as REDCap XML File | exportProjectXml exportProjectXml.redcapApiConnection |
| Export the REDCap Version Number | exportVersion exportVersion.redcapApiConnection |
| Extraction and Assignment for 'redcapFactor's | Extraction print.redcapFactor [.redcapFactor |
| Functions for Casting Fields After Export (Post Processing) | castForImport fieldCastingFunctions guessCast guessDate mChoiceCast recastRecords |
| Split a Field Choice Mapping Into a Two Column Matrix | fieldChoiceMapping fieldChoiceMapping.character fieldChoiceMapping.redcapApiConnection |
| Convert a REDCap Data Field to an R Vector | fieldToVar |
| Helper functions for 'exportRecordsTyped' Validation and Casting | castCheckCode castCheckCodeCharacter castChecked castCheckedCharacter castCheckForImport castCheckLabel castCheckLabelCharacter castCode castCodeCharacter castDpCharacter castDpNumeric castLabel castLabelCharacter castLogical castRaw castTimeHHMM castTimeMMSS default_cast_character default_cast_no_factor fieldValidationAndCasting isNAorBlank na_values raw_cast skip_validation valChoice valPhone valRx valSkip |
| Export, Import, or Delete Files to a Field in a REDCap Project | deleteFiles deleteFiles.redcapApiConnection exportFiles exportFiles.redcapApiConnection fileMethods importFiles importFiles.redcapApiConnection |
| Export, Import, or Delete Multiple Files from the File Repository | deleteFileRepository deleteFileRepository.redcapApiConnection exportFileRepository exportFileRepository.redcapApiConnection fileRepositoryMethods importFileRepository importFileRepository.redcapApiConnection |
| Reconstruct the file repository path | fileRepositoryPath |
| Remove Rows Containing Only Missing Values | filterEmptyRow |
| Export, Import, and Delete Individual Files from the File Repository | deleteFromFileRepository deleteFromFileRepository.redcapApiConnection exportFromFileRepository exportFromFileRepository.redcapApiConnection fromFileRepositoryMethods importToFileRepository importToFileRepository.redcapApiConnection |
| Return a vector of the Project ID Fields | getProjectIdFields |
| Import a File With Option to Create A Record to Receive the File | importFileToRecord |
| Import Records to a Project | importRecords importRecords.redcapApiConnection |
| Helper functions for formatting validation failure report | format.invalid invalidSummary print.invalid summary.invalid |
| Identify Check Fields with a Zero Coded Option | isZeroCodedCheckField warnOfZeroCodedCheckCasting warnZeroCodedFieldPresent |
| Make REDCap API Calls | makeApiCall |
| Export and Import Instrument-Event Mappings | exportMappings exportMappings.redcapApiConnection importMappings importMappings.redcapApiConnection mappingMethods |
| Export and Import the Project Meta Data (Data Dictionary) | exportMetaData exportMetaData.redcapApiConnection importMetaData importMetaData.redcapApiConnection metaDataMethods metaDataMethodsArgs |
| Report of Missing Values | missingSummary missingSummary.redcapApiConnection missingSummary_offline |
| Parse Branching Logic | parseBranchingLogic |
| Prepare User Data for Import | prepUserImportData |
| Preserve Project Data Locally | preserveProject preserveProject.redcapApiConnection readPreservedProject readPreservedProject.character readPreservedProject.list |
| Export and Import Project Settings | exportProjectInformation exportProjectInformation.redcapApiConnection importProjectInformation importProjectInformation.redcapApiConnection projectInformationMethods |
| Purge and Restore Project Data | purgeProject purgeProject.redcapApiConnection purgeRestoreProject restoreProject restoreProject.list restoreProject.redcapApiConnection |
| Change labeling of 'checkbox' variables | recodeCheck |
| Save a File to a Local Directory from a Response | reconstituteFileFromExport |
| Export Next Record Name or Rename a Record | exportNextRecordName exportNextRecordName.redcapApiConnection recordsManagementMethods renameRecord renameRecord.redcapApiConnection |
| Export Records and Reports | exportRecords exportRecords.redcapApiConnection exportRecords_offline exportReports exportReports.redcapApiConnection recordsMethods |
| Export Records or Reports From a Project | exportRecordsTyped exportRecordsTyped.redcapApiConnection exportRecordsTyped.redcapOfflineConnection exportReportsTyped exportReportsTyped.redcapApiConnection recordsTypedMethods |
| Connect to a REDCap Database | offlineConnection print.redcapApiConnection print.redcapOfflineConnection redcapConnection |
| REDCap Data Structures | redcapDataStructures REDCAP_METADATA_FIELDTYPE REDCAP_METADATA_VALIDATION_TYPE REDCAP_PROJECT_PURPOSE REDCAP_REPEAT_INSTRUMENT_STRUCTURE REDCAP_SYSTEM_FIELDS validateRedcapData |
| Convert REDCap factors between labeled and coded | redcapFactorFlip |
| Export or Import Repeating Instrument and Events Settings | exportRepeatingInstrumentsEvents exportRepeatingInstrumentsEvents.redcapApiConnection importRepeatingInstrumentsEvents importRepeatingInstrumentsEvents.redcapApiConnection repeatingInstrumentEventMethods repeatingInstrumentMethods |
| Review Invalid Records Following Field Validation | reviewInvalidRecords |
| Split a Data Frame into its Forms | splitForms |
| Remove Undesired Characters From Strings | stringCleanup stripHTMLTags stripUnicode |
| Helper Functions for 'exportRecordsType' Attributes | stripHTMLandUnicode unitsFieldAnnotation |
| Export Survey Participant Information | exportSurveyLink exportSurveyLink.redcapApiConnection exportSurveyParticipants exportSurveyParticipants.redcapApiConnection exportSurveyQueueLink exportSurveyQueueLink.redcapApiConnection exportSurveyReturnCode exportSurveyReturnCode.redcapApiConnection surveyMethods |
| Switch Data Access Group Assignment for the Current User | switchDag switchDag.redcapApiConnection switchDagArgs |
| Synchronize coding of checkbox variables between meta data and records field names. | syncUnderscoreCodings |
| Open REDCap connections using cryptolocker for storage of API_KEYs. | unlockREDCap |
| Export, Import, or Delete Users and User Permissisons | deleteUsers deleteUsers.redcapApiConnection exportUsers exportUsers.redcapApiConnection importUsers importUsers.redcapApiConnection userMethods |
| Export or Import User-Role Assignments | exportUserRoleAssignments exportUserRoleAssignments.redcapApiConnection importUserRoleAssignments importUserRoleAssignments.redcapApiConnection userRoleAssignmentMethods |
| Export, Import, or Delete User Roles in a Project | deleteUserRoles deleteUserRoles.redcapApiConnection exportUserRoles exportUserRoles.redcapApiConnection importUserRoles importUserRoles.redcapApiConnection userRoleMethods |
| Validate Data Frames for Import | validateImport |
| Convert R Vector To List for the API Call Body | vectorToApiBodyList |
| Transform Data Into Wide Format | widerRepeated |
| Prepare a Data Frame for Import Through the API | writeDataForImport |