exportInstruments: Exports the REDCap Instruments

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

View source: R/exportInstruments.R

Description

Returns a data frame of instruments, names, etc.

Usage

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

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

## S3 method for class 'redcapApiConnection'
exportInstruments(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

REDCap Version

6.5.0 +

5.8.2+

REDCap API Documentation

This function allows you to export a list of the data collection instruments for a project. This includes their unique instrument name as seen in the second column of the Data Dictionary, as well as each instrument's corresponding instrument label, which is seen on a project's left-hand menu when entering data. The instruments will be ordered according to their order in the project.

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 May 12, 2018, 1:05 a.m.