Export the Events for a Project
Retrieve a data frame giving the events, event names, and offsets for the events in a project
1 2 3 4 5 6 7
A REDCap connection object as generated by
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.
The data frame that is returned shows the event name, arm number, days offset, minimum offset, maximum offset, and unique event name.
When this function is called for a classic project, a character string is returned giving the API error message, '400: You cannot export events for classic projects' but without casting an error in R. This is by design and allows more flexible error checks in certain functions
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
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
## Not run: > #*** Note: I cannot provide working examples without > #*** compromising security. Instead, I will try to > #*** offer up sample code with the matching results > > #*** Create the connection object > rcon <- redcapConnection(url=[YOUR_REDCAP_URL], token=[API_TOKEN]) > > exportEvents(rcon) event_name arm_num day_offset offset_min offset_max unique_event_name 1 Event 1 1 0 0 0 event_1_arm_1 2 Follow Up 1 1 1 0 0 follow_up_1_arm_1 3 Follow Up 2 1 2 0 0 follow_up_2_arm_1 ## End(Not run)
Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.