Retrieve a data frame giving the users, expiration dates, and data access privileges for each user.
exportEvents(rcon, ...)# S3 method for redcapApiConnection
exportEvents(
rcon,
arms = NULL,
...,
error_handling = getOption("redcap_error_handling"),
config = list(),
api_param = list()
)
Returns a data frame with six columns
event_name The descriptive name of the event.
arm_num The arm number in which the event occurs.
day_offset The days offset from the first event.
offset_min The minimum offset value.
offset_max The maximum offset value.
unique_event_name A unique event identifying name.
A REDCap connection object as generated by redcapConnection.
Arguments to be passed to other methods.
A numeric vector or arm numbers to retrieve. Will also accept a character vector, but will coerce to numeric before processing.
An option for how to handle errors returned by the API.
see redcap_error
list Additional configuration parameters to pass to
POST. These are appended to any parameters in
rcon$config.
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.
This function allows you to export the events for a project
NOTE: this only works for longitudinal projects.
5.8.2+
None
Benjamin Nutter
It is not sufficient to make the project a longitudinal project. The
project must satisfy one of two conditions: 1) have at least two arms and
one event defined; or 2) have one arm and at least two events defined. If
neither of these conditions are satisfied, the API will return a message
such as ERROR: You cannot export arms for classic projects, an
error message that isn't as descriptive of the nature of the problem as
we might like.
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