redcapAPI 2.12.0

Breaking changes

• unlockREDCap upstream dependency on shelter now default to 'SHELTER_' prefix when looking for ENV variable overrides.

Minor improvements and fixes

• exportDags, exportFieldNames, exportProjectInformation, exportReportsTyped, importDags, writeDataForImport, and exportRecordsTyped now have a csv_delimiter parameter to control delimiter utilized.
• importMetaData bug fix when given duplicate names to exit and warn user properly.
• redcapUserRoleStructure allows new alerts, api_modules, and data_quality_resolution attributes.
• exportUsers properly handles the columns random_setup, random_dashboard and random_perform.
• importUsers and exportUsers weren't handling data_access_group assignment properly.
• exportUserRoles now avoids errors when user role access columns are missing from export responses.
• exportFileRepositoryListing returns a data.frame with 6 columns (was 4) from REDCap version 16.0.8 and up.
• redcapConnection has better documentation on setting the CSV delimiter and this is respected through most calls except for ones that have been shown to be hard coded to commas by REDCap.

DEPRECATION NOTICES

A future release of version 3.0.0 will introduce several breaking changes!

• The exportRecords function interface will be replaced. Please switch your processes to exportRecordsTyped
• The importRecords function interface will be replaced to utilize castForImport to prepare data for import. Validation logs will no longer be printed.
• The redcapFactor class is being discontinued with all its supporting methods (including redcapFactorFlip). Please use recastRecords instead.
• The recodeCheck function is being discontinued. Please use recastRecords instead.

v2.11.5

• prepUserImportData_validateAllFormsPresent and prepUserImportData_extractFormName functions are removed.
• Enhanced logging of exporting records to include record_id and other non-PHI info.
• Updated user role permissions to use new numbering scheme based on REDCap version.
• unlockREDCap adds trailing slash to url if not present.
• importUsers improved error message when invalid columns are provided.
• Added data_access_group_label to allowed user attributes.
• Added data_quality_resolution to allowed user attributes. It may be unnecessary.

v2.11.4

2.11.4

• Updated to allow for project_pi_email as an allowed field of project info.
• Updated to allow for data_access_group as part of user role assignment.

v2.11.3

2.11.3

• Added injectable log function for use in production environments or debugging.

2.11.2

• Fixed bug in exportDataQuality when no quality issues exist.
• Deprecated functions exportProjectInfo and exportBundle have been removed.
• Fixed offline test that was having issue on Windows.
• Fixed bug in exportFilesMultiple.

v2.11.1

• Better handling of unexpected html responses from REDCap.
• Improved CSV formatting for API imports. Properly deals with escaped quoting.
• Allow for overlapping mapping in radio import validation.
• Restored debug mode for API call/response. Just add config=list(options=list(verbose=TRUE)) to unlockREDCap or any call.
• Added experimental exportSAS.

v2.11.0

• unlockREDCap internal code is now in package shelter.

This brings about some improved crypto and there are functions to bridge over the older keyrings automatically.

v2.10.0

2.10.0

• Replace "httr" dependency with "curl"

2.9.4

• Minor code refactoring
• Add test case for CI environment
• Implemented GitHub Actions for automated source code checks.

2.9.3

• REDCap 14.4.0 changed user role structure.

2.9.2

• Improved date and datetime validation
• Bug fix for importMetaData validation
• Refactored error handling on API calls to reduce code footprint.
• Added redcap_survey_identifier to system field list.
• Bug fix for handling fields ending in '_complete' that are not form related.
• Added batching method for exportLogging.

v2.9.1

• Added additional supported arguments to deleteRecords.
• Changed the default to dag=FALSE for exportRecordsTyped.
• exportRecordsTyped more robust against some forms of corrupted meta data.
• Added a new feature exportDataQuality for pulling queries from the DataQuality module.

v2.9.0

• Refactor of missingSummary to use exportRecordsTyped. This is a breaking change in prep of 3.0.0.
• Added handling of url redirects (301,302) on makeApiCall.
• importRecords stops when provided fields not in the project.
• Filtering empty records will use mapping if available
• Minor export optimizations for records.
• unlockREDCap will now search for ENV variables.
• New importFileToRecord which will import a file and create the record if it doesn't exist.

v.2.8.4 CRAN Release

• Patch to reading HTTP data. When non UTF-8 characters are sent, they get mapped to '□'.
• Documentation updates, and proper attributes added.