redcapAPI (version 2.8.0)

exportInstruments: Export Instruments Defined in a Project

Description

These methods enable the user to view the instruments defined in the project.

Usage

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

Value

Returns a data frame with the columns:

instrument_name	The REDCap generated instrument name.
instrument_label	The user provided instrument label.

Arguments

rcon

A redcapConnection object.

...

Arguments to pass to other methods

error_handling

character(1). One of c("error", "null"). An option for how to handle errors returned by the API. see redcapError().

config

A named list. Additional configuration parameters to pass to httr::POST(). These are appended to any parameters in rcon$config.

api_param

A named 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.

See Also

exportMetaData(),
importMetaData(),
exportInstruments(),
exportMappings(),
importMappings(),
exportPdf()

Examples

if (FALSE) {
unlockREDCap(connections = c(rcon = "project_alias"), 
             url = "your_redcap_url", 
             keyring = "API_KEYs", 
             envir = globalenv())
 
exportInstruments(rcon)
}