redcap_version: Determine version of REDCap instance

Description Usage Arguments Details Value Examples

View source: R/redcap-version.R

Description

This function uses REDCap's API to query its version.

Usage

1
redcap_version(redcap_uri, token, verbose = TRUE)

Arguments

redcap_uri

The URI (uniform resource identifier) of the REDCap project. Required.

token

The user-specific string that serves as the password for a project. Required.

verbose

A boolean value indicating if messages 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.

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::package_version. It guarantees the value can always be used in utils::compareVersion().

Value

A utils::packageVersion.

Examples

1
2
3
4
library(REDCapR) #Load the package into the current R session.
uri      <- "https://bbmc.ouhsc.edu/redcap/api/"
token    <- "9A81268476645C4E5F03428B8AC3AA7B"
redcap_version(redcap_uri=uri, token=token)

REDCapR documentation built on May 29, 2017, 9:24 a.m.