Retrieve a data frame giving the events-form mapping for a project.
exportMappings(rcon, arms, ...)# S3 method for redcapApiConnection
exportMappings(
rcon,
arms = NULL,
...,
error_handling = getOption("redcap_error_handling")
)
A REDCap connection object as generated by redcapConnection.
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
An option for how to handle errors returned by the API.
see redcap_error
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
5.8.2+ (and earlier, but we don't know how much earlier)
None
Benjamin Nutter
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.
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