exportVersion: Exports the REDCap Version Number

Description Usage Arguments Details REDCap API Documentation (6.5.0) REDCap Version Known REDCap Limitations Author(s) References

View source: R/exportVersion.R

Description

Version numbers are returned as a character string. This feature is available for REDCap 6.0.0 and higher.

Usage

1
2
3
4
5
6
7
8
exportVersion(rcon, ...)

## S3 method for class 'redcapDbConnection'
exportVersion(rcon, ...)

## S3 method for class 'redcapApiConnection'
exportVersion(rcon, ...,
  error_handling = getOption("redcap_error_handling"))

Arguments

rcon

A REDCap connection object as generated by redcapConnection

...

Arguments to be passed to other methods.

error_handling

An option for how to handle errors returned by the API. see redcap_error

Details

If this function is used in a version of REDCap that does not support the Export Version Number function, the character string '5.12.2' is returned. This is done solely for the convenience of always returning a value that can be compared against other versions.

REDCap API Documentation (6.5.0)

This method returns the current REDCap version number as plain text (e.g., 4.13.18, 5.12.2, 6.0.0).

REDCap Version

6.0.0+

Known REDCap Limitations

None

Author(s)

Benjamin Nutter

References

Please refer to your institution's API documentation.

Additional details on API parameters are found on the package wiki at https://github.com/nutterb/redcapAPI/wiki/REDCap-API-Parameters


redcapAPI documentation built on Jan. 20, 2018, 9:37 a.m.