redcapAPI (version 1.3)

exportUsers: Export the Users for a Project

Description

Retrieve a data frame giving the users, expiration dates, and data access privileges for each user.

Usage

exportUsers(rcon, ...)
# S3 method for redcapDbConnection
exportUsers(rcon, date = TRUE, label = TRUE,
  ...)
# S3 method for redcapApiConnection
exportUsers(rcon, date = TRUE, label = TRUE,
  ...)

Arguments

rcon

A REDCap connection object as generated by redcapConnection.

...

Arguments to be passed to other methods.

date

Logical. Indicates if the expiration date is converted to a POSIXct object.

label

Logical. Indicates if the data export and form access rights are converted to factor objects.

Details

From the REDCap API Documentation:

Data Export: 0=no access, 2=De-Identified, 1=Full Data Set Form Rights: 0=no access, 2=read only, 1=view records/responses and edit records (survey responses are read-only), 3 = edit survey responses

(NOTE: At this time, only a limited amount of rights-related info will be exported (expiration, data access group ID, data export rights, and form-level rights). However, more info about a user's rights will eventually be added to the Export Users API functionality in future versions of REDCap.)

For some reason I have yet to identify, some User Tables do not export correctly. In some situations, the fields are all shifted one column to the left and the form names are not always exported. This seems to be more common in projects still in Development mode. I have seen one instance of a project in Production where one user had one more column given than any other user. If you notice this behavior, please report it to me as it may help me narrow down the source of the problem

References

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

Examples

# 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])
>
> exportUsers(rcon)
> #*** 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])
>
> exportUsers(rcon)
username            email firstname lastname expiration data_access_group
1    user1 [e-mail]     Name1 Surname1       <NA>                NA
2    user2             <NA>      <NA>     <NA>       <NA>                NA
3    user3 [e-mail]     Name3 Surname3       <NA>                NA
4    user4             <NA>      <NA>     <NA>       <NA>                NA
5    user5 [e-mail]     Name5 Surname5       <NA>                NA
6    user6             <NA>      <NA>     <NA>       <NA>                NA
7    user7 [e-mail]     Name7 Surname7       <NA>                NA
data_export                 patient_characteristics
1 Full data set view records/responses and edit records
2 De-identified view records/responses and edit records
3 De-identified view records/responses and edit records
4 De-identified view records/responses and edit records
5 Full data set view records/responses and edit records
6 De-identified view records/responses and edit records
7 Full data set view records/responses and edit records
dxa_scan_summary
1 view records/responses and edit records
2 view records/responses and edit records
3 view records/responses and edit records
4 view records/responses and edit records
5 view records/responses and edit records
6 view records/responses and edit records
7 view records/responses and edit records
# }