forked from vubiostat/redcapAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNEWS
113 lines (103 loc) · 6.78 KB
/
NEWS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
## Changes in Version 2.2 (no scheduled date)
* BREAKING CHANGE: The `dev_allocate` and `prod_allocate` elements of the
object returned by `allocationTable` have been named `dev_allocation` and
`prod_allocation`, respectively.
* Bug fix: `importRecords` now handles data with repeating forms correctly.
* New feature: UTF-8 Characters may be stripped from the data dictionary.
## Change up to Version 2.1 (2018-03-03)
* Bug fix: Add `[form]_complete` fields
* Bug fix: Include `[form]_complete` fields in Reports
* New feature: `[form]_complete` fields may be explicitly requested.
* New feature: Automatic selection of `[form]_complete` fields may be turned off.
## Changes in Version 2.0 (2017-01-18)
* redcapDbConnection methods are being deprecated. To our knowledge, no one
is using these methods, and we do not believe they would work as previously
coded anyway. The methods definitions continue to be reserved although
they will likely not be developed in the forseeable future (if at all).
Please file an issue on GitHub if you feel such methods would be of use.
* `redcapProjectInfo` is being deprecated, as it will inevitably create confusion
with the API method `exportProjectInformation`. The replacement function is
`exportBundle`.
* export bundles are now placed into the option `redcap_bundle` by default.
For now, exportBundle will also return that same object. This is to prevent
back-compatibility problems with existing code, but will change at a future date.
* Added several new API functions. All functions up to REDCap 6.5.0 are included.
* Optional arguments that previously had no default now default to NULL. There
should be no change in behavior related to this change.
* Further standardization to documentation. Each function has three new sections:
"From the REDCap Documentation" which gives the description of the function as
taken from the REDCap documentation; "REDCap Version" which gives the versions of
REDCap for which the function is known to operate; and "Known REDCap Limitations"
which documents any bugs or other limitations that may be encountered when working
with the API
* the `fieldToVar` function now operates on a switch statement instead of a sequence
of `if else` blocks. It also incorporates a `for` loop in place of the
`lapply` and `<<-` structure.
* Error checking, when feasible, makes use of the `checkmate` package.
* `exportVersion` will now return "5.12.2" for all versions of REDCap less than 6.0.0.
While it is admittedly odd, this allows for consistent logical comparisons of
of versions and allows better control of the package's behavior over multiple
versions of REDCap.
* REDCap variables that can reasonably be treated as factors are given an additional
class, `redcapFactor`, that inherits whatever class the variable becomes on
export. For example, if `factors = TRUE`, the new class will be
`c("redcapFactor", "factor")`, otherwise, it may be something similar to
`c("redcapFactor", "numeric")`. This is done to assist in converting factors
back and forth between classes as needed (particular when using `redcapFactorFlip`).
* An package option is added for how to manage errors returned by the API. This is
used to assist in dealing with errors relating to bugs in the API and/or the user's
version of REDCap. For instance, if an API method doesn't exist for the user's
version of REDCap, the user can control if a hard error is returned, or if a
`NULL` value is returned. See `?redcap_error` for details.
* Codebase has been standardized and given a cleaner format (yeah, that's totally
subjective)
Changes in Version 1.3.5 (2017-01-20)
* Bug fixes from @tobadia. (Issue #79)
Changes in Version 1.3.2 (2015-12-09)
* Bug fix. Changed the call to fieldToVar in exportReports; was incorrectly referencing the meta_data field names. Thanks to Will Campbell for finding this bug.
Changes in Version 1.3.1 (2015-07-05)
* Changed the default `config` argument in `redcapConnection` from `config=list()`
to `config=httr::config()`.
* Added code to allow all errors from `apiCall` to be returned correctly.
Changes in Version 1.3 (2015-03-04)
* The Maintainer has been changed to Stephen Lane
* Bug fix: The REDCap API Error message for `exportEvents`, `exportArms`, and
`exportMappings` changed between versions 5.x and 6.0. In 5.x, the error
message is "You cannot export arms for classic projects." In 6.0+, it is
"ERROR: You cannot export arms for classic projects." The change causes
`exportEvents`, `exportArms`, and `exportMappings` to cast an error instead
of returning the character string with the error. The bug fix accomodates
the error messages from both 5.x and 6.0+.
## Changes in Version 1.2 (2015-02-01)
* Code has been rewritten to make use of the `roxygen2` documenation style.
* The function 'allocationTable' is added. This assists in producing
allocation tables for the randomization module.
* Offline versions for 'exportRecords' and 'allocationTable' are
included. These produce output identical to the API calls, but
operate based on the csv's downloaded via the user interface.
## Changes in Version 1.1 (2014-10-01)
* redcapAPI now depends on R 3.0.0 or higher
* A bug fix was added. When specifying the 'fields' and 'forms' arguments
in 'exportRecords', only the variables in 'fields' were being converted
to the appropriate data types. This has been corrected.
* redcapAPI requires Hmisc 3.14-6 or higher. This is a consequence of
the following item. Please update your Hmisc package.
* The Hmisc package was moved from the Suggests field to the Imports
field. This reflects the addition of some of the label functions in
Hmisc being explicitly exported, making them available to import.
## Changes in Version 1.0.1 (2014-10-20)
* Bug fix: in `importRecords` meta data was not previously exported
when a project info object was not provided. This is now corrected
* Bug fix: in `exportRecords` and `exportReports`, the checkbox labels
weren't being returned as factor levels when `checkboxLabels=TRUE`.
The behavior is now consistent with expectations.
* Bug fix: in `compareRedcapVersion`, a logical check was failing due
to an ommitted argument in `grepl`. This has been corrected.
* added function `apiCall`. This wraps a call to `tryCatch`. If a
Gnu/TLS recv error is returned, the encoding is changed from 'gzip'
to 'identity' to successfully retrieve the API response.
* `tryCatch` calls are added to `redcapProjectInfo` to prevent fatal
errors when one of the API functions casts an error. The output
is modified to indicate where the problem occurred. This is most
likely to affect `exportUsers`. An unresolved issue behind this is
logged in the issues on Github.