exportMappings: Exports the Event-Form Mappings for a Project

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

View source: R/exportMappings.R

Description

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

Usage

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

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

## S3 method for class 'redcapApiConnection'
exportMappings(rcon, arms = NULL, ...,
  error_handling = getOption("redcap_error_handling"))

Arguments

rcon

A REDCap connection object as generated by redcapConnection.

arms

A vector of arm numbers that you wish to pull events for (by default, all events are pulled)

...

Arguments to be passed to other methods

error_handling

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

Details

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

When this function is called for a classic project, a character string is returned giving the API error message, '400: You cannot export form-event mappings for classic projects' but without casting an error in R. This is by design and allows more flexible error checks in certain functions.

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(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.