Learn R Programming

redcapAPI (version 2.7.4)

exportRepeatingInstrumentsEvents: Export Repeating Instruments and Events Settings

Description

This method allows you to export a list of the repeated instruments and repeating events for a project. This includes their unique instrument name as seen in the second column of the Data Dictionary, as well as each repeating instrument's corresponding custom repeating instrument label. For longitudinal projects, the unique event name is also returned for each repeating instrument. Additionally, repeating events are returned as separate items, in which the instrument name will be blank/null to indicate that it is a repeating event (rather than a repeating instrument).

Usage

exportRepeatingInstrumentsEvents(rcon, ...)

# S3 method for redcapApiConnection exportRepeatingInstrumentsEvents( rcon, ..., error_handling = getOption("redcap_error_handling"), config = list(), api_param = list() )

Arguments

rcon

A redcapConnection object.

...

Arguments to pass to other methodsArguments to be passed to other methods.

error_handling

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

config

list Additional configuration parameters to pass to POST. These are appended to any parameters in rcon$config.

api_param

list Additional API parameters to pass into the body of the API call. This provides users to execute calls with options that may not otherwise be supported by redcapAPI.