exportSurveyParticipants: Exports details of participants for a given survey

Description Usage Arguments Details Author(s)

View source: R/exportSurveyParticipants.R

Description

Retrieving dataframe of survey participants managed in REDCap

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
exportSurveyParticipants(rcon, instrument, event, ...)

## S3 method for class 'redcapDbConnection'
exportSurveyParticipants(rcon, instrument, event, ...)

## S3 method for class 'redcapApiConnection'
exportSurveyParticipants(
  rcon,
  instrument,
  event,
  ...,
  error_handling = getOption("redcap_error_handling")
)

Arguments

rcon

A REDCap connection object as generated by redcapConnection.

instrument

A string type holding the name of "instrument" or survey the participants are managed under

event

A string type holding the name of the event that the instrument belongs to

...

additional arguments to pass to other methods.

error_handling

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

Details

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.

Author(s)

Paddy Tobias


redcapAPI documentation built on Feb. 18, 2020, 1:09 a.m.