Releases: vubiostat/redcapAPI
Releases · vubiostat/redcapAPI
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 useexportRecordsTyped
. 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.
v2.8.3
- Patch to date range handling that was breaking on new REDCap projects since version 14.0.2 of the REDCap server.
- Improved speed / memory usage for empty row exclusion.
- Checkbox field labels now follow the pattern '[field_label] (choice=[choice_label])'
- Fixed checkbox handling to be consistent with data export tool.
- Added
skip_validation
list to complementraw_cast
. - Extends casting and validation to text fields validated with the BioPortal Ontology service.
- Extends casting and validation to sql fields.
- Adds
valSkip
, allowing for validation to be skipped for a field type. - Adds
castLogical
casting function. - Adds four vignettes for getting started with using
unlockREDCap
andexportRecordsTyped
. - Added helper function
changedRecords
. - Added
assembleCodebook
, which mimics the codebook in the REDCap UI in the form of a data frame. - New functions for project management: createRedcapProject, exportProjectXml
- Additional timeout trap for request retry strategy.
- Reports of data failing validation checks now include a link to the form with the failing data.
- Major cleanup to remove messages on successful function execution. Many return values are changed to be consistent and be TRUE/FALSE if possible.
- Bug fix: The repeat_instance argument of exportFiles is now included in the API call.
- New Vignette: vignette("redcapAPI-offline-connection")
- Adds
exportFilesMultiple
to facilitate exporting multiple files in a familiar interface. - Bug fix: Batching records no longer has the potential to produce duplicated records when a record ID has data in multiple events. (See Issue 262)
- Extends
preserveProject
and addsreadPreservedProject
to assist with preparing data for offline users.
v2.8.0 CRAN
2.8.0
- Changed
importArms
andimportEvents
to usedata
argument for consistency. Backward compatible via...
. - Added several functions for manipulating DAGs.
- Fixed bug in zero coded fields. NOTE: It is impossible to handle every possible case as the definition of zero coded fields in REDCap can be inconsistent.
- Fixed issue in importUsers where existing roles might get dropped on an update. Now handles the multiple API calls seemlessly to properly handle user roles.
- Fixed issue with decimal validation.
- Added renameRecord function.
- Fixed issue with preserving missing values in preparing checkbox fields for import
- Added
default_cast_no_factor
, a list of casting functions that may be used to cast fields without casting any fields to factors. It comes with an equivalent aliasdefault_cast_character
. - Documentation has been standardized. Related methods are now documented in the same
help file. - Add several functions for exporting Survey links and return codes
- Replaced depricated function with_mock with with_mocked_bindings
2.7.5
- added filter_empty_rows flag to exportRecordsTyped.
2.7.4
2.7.4
- Fixed upper/lower case for AND/OR in parseBranchingLogic
- Added a
system
field type for mapping withcastLabel
andcastRaw
. - DAGs are added to connection cache.
- Timeout on connections defaults to 5m.
- Clearer error message on connection closed.
- export/import handles the 'now' and 'today' validation words for dates and date/times.
- unlockREDCap: major refactor / rewrite. Many edges cases handled gracefully with better error messaging. Now with less password requests.
2.7.3
- dags: Added ability to get DAG information from connection object, e.g.
rcon$dags()
- exportBulkRecords: When no forms are specified, it defaults to all instruments for the project.
- importRecords: Got rid of warning about dropping fields that were already dropped.
- mChoiceCast: Added configurable dropping of choice fields that were aggregated. Defaults to drop.
- unlockREDCap: Defaults to RStudio password prompt if available. Uses
askpass
option. General improvements in error messages.
2.7.2
- Spelling/Grammar cleanup
envir
parameter allows passing a number of the environment- New functions use pre-existing error handling strategy.
CRAN 2.7.1
2.7.1
Version bump for CRAN publication
Changes in Version 2.7.0
- The new function exportRecordsTyped is now available as a replacement for the existing exportRecords. It is a breaking change in interface--but provides
far better stability in calling--full inversion of control over casting, retries through the connection object, and a clear error report as part of the final dataframe. Please take a moment to read the documentation on exportRecordsTyped and start moving over to using it over exportRecords. - bundle argument has been removed from all API methods. (It is no longer needed, thanks to caching). Backward compatibility is unaffected.
- Introduces the offlineConnection function, which creates the redcapOfflineConnection object. This connection object can be built using either data frames structured like those received from the API methods, or the CSV files downloaded from the REDCap UI. The object function in the same way as an API connection with caching. Meta data can be retrieved via rcon$metadata(), etc..
- added castForImport. Recasts a
data.frame
back into the expected text values. - added exportReportsTyped. Similar to exportRecordsTyped. * Helper function exportBulkRecords for bulk calls to exportRecordsTyped.
Changes in Version 2.6.2
- Added retry parameter to connection object. On timeouts and gateway failures it retries 5 times now by default.
- Cleanup from emergency patches.
Changes in Version 2.6.1
- Emergency fix. REDCap latest version has changed it's API calling syntax.
- Fix to choice name parsing when only a single choice is specified.
- Fix to importMethod validators when event=NULL
Changes in Version 2.6.0
- A set of functions to deal with file import / export in REDCap
- exportFileRepositoryListing
- exportFromFileRepository
- exportFileRepository
- importToFileRepository
- deleteFromFileRepository
- createFileRepositoryFolder
- importFileRepository
- deleteFileRepository
Release 2.5.0
- IMPORTANT: The upcoming 3.0.0 release will be a breaking change for exportRecords. This is needed for full inversion of control to the user over type casting.
- Fully removed deprecated redcapDbConnection
- Added a drop= argument to exportRecords and exportReports. These columns are dropped before returning.
- Metadata is cached in the connection object. In addition to token, url, and config elements, the following are also made available:
- metadata
- arms
- events
- fieldnames
- mapping
- users
- version
- projectInformation
each of these has a companion function - has_* (returns a logical indicating if the element has been cached)
- flush_* (removes the cached value)
- refresh_* (replaces the cached value with a fresh call to the API)
There are also flush_all and refresh_all methods.
- New method: exportLogging
- Fixed minor bugs in validations and improved documentation
- Fixed bug in formating vectors for API calls in multiple places #33
- Removed stringr and tidyr as dependencies
- Removed unused version argument from checkbox_suffix
- Fixed error thrown in export_users when labels=TRUE
- Greatly expanded test coverage
- mChoice class addition if Hmisc is installed
Version 2.4.0
Adding user definable handlers for REDCap field types. Issue #6