Export Instrument names

Description

Retrieve a data frame giving the instrument names and labels in a project.

Usage

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

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

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

Arguments

rcon

A REDCap connection object as generated by redcapConnection

...

Arguments to be passed to other methods

Details

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.

This function was introduced to the API in version 5.9. An error will be returned if called to an instance earlier than 5.9.

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