Retrieving dataframe of survey participants managed in REDCap
exportSurveyParticipants(rcon, instrument, event, ...)# S3 method for redcapApiConnection
exportSurveyParticipants(
rcon,
instrument = NULL,
event = NULL,
...,
error_handling = getOption("redcap_error_handling"),
config = list(),
api_param = list()
)
A REDCap connection object as generated by redcapConnection.
A string type holding the name of "instrument" or survey the participants are managed under
A string type holding the name of the event that the instrument belongs to
additional arguments to pass to other methods.
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.
Paddy Tobias
REDCap allows the user to manage a list of participants (if they are known) for each survey. This function pulls this information into a dataframe. The contents of the dataframe are the contact fields of the participants, the link to the survey for that participant if the participant hasn't completed the survey yet (otherwise, NA), the participants record id, and other information.