This function uses REDCap's API to query its version.
redcap_version(
redcap_uri,
token,
verbose = TRUE,
config_options = NULL,
handle_httr = NULL
)
The uri/url of the REDCap server typically formatted as "https://server.org/apps/redcap/api/". Required.
The user-specific string that serves as the password for a project. Required.
A boolean value indicating if message
s should be printed
to the R console during the operation. The verbose output might contain
sensitive information (e.g. PHI), so turn this off if the output might
be visible somewhere public. Optional.
A list of options passed to httr::POST()
.
See details at httr::httr_options()
. Optional.
The value passed to the handle
parameter of
httr::POST()
.
This is useful for only unconventional authentication approaches. It
should be NULL
for most institutions. Optional.
If the API call is unsuccessful, a value of
base::package_version("0.0.0")
will be returned.
This ensures that a the function will always return an object of class
base::numeric_version. It guarantees the value can always be used in
utils::compareVersion()
.
uri <- "https://bbmc.ouhsc.edu/redcap/api/"
token <- "9A81268476645C4E5F03428B8AC3AA7B"
REDCapR::redcap_version(redcap_uri = uri, token = token)
#> The REDCap version was successfully determined in 0.2 seconds. The http status code was 200. Is is 13.9.1.
#> [1] ‘13.9.1’