exportMappings: Exports the Event-Form Mappings for a Project

Description

Retrieve a data frame giving the events-form mapping for a project.

Usage

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

Arguments

rcon: A REDCap connection object as generated by redcapConnection.
arms: integerish A vector of arm numbers that you wish to pull events for (by default, all events are pulled). Will also accept character, but will coerce it to numeric before processing.
...: Arguments 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.

REDCap API Documentation

This function allows you to export the instrument-event mappings for a project (i.e., how the data collection instruments are designated for certain events in a longitudinal project).

NOTE: this only works for longitudinal projects

REDCap Version

5.8.2+ (and earlier, but we don't know how much earlier)

Known REDCap Limitations

None

Author

Benjamin Nutter

Details

The data frame that is returned shows the arm number, unique event name, and forms mapped in a project.

If the project information reports that the project is not longitudinal, a data frame with 0 rows is returned without calling the API.

References

Please refer to your institution's API documentation.

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