redcap_version {REDCapR} | R Documentation |
Determine version of REDCap instance
Description
This function uses REDCap's API to query its version.
Usage
redcap_version(
redcap_uri,
token,
verbose = TRUE,
config_options = NULL,
handle_httr = NULL
)
Arguments
redcap_uri |
The uri/url of the REDCap server typically formatted as "https://server.org/apps/redcap/api/". Required. |
token |
The user-specific string that serves as the password for a project. Required. |
verbose |
A boolean value indicating if |
config_options |
A list of options passed to |
handle_httr |
The value passed to the |
Details
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()
.
Value
Examples
uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/"
token <- "9A068C425B1341D69E83064A2D273A70"
REDCapR::redcap_version(redcap_uri = uri, token = token)