exportUsers: Export the Users for a Project

Description Usage Arguments Details Value REDCap API Documentation (6.5.0) REDCap Version Known REDCap Limitations Author(s) References

View source: R/exportUsers.R

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
exportUsers(rcon, ...)

## S3 method for class 'redcapDbConnection'
exportUsers(rcon, dates = TRUE, labels = TRUE,
  ...)

## S3 method for class 'redcapApiConnection'
exportUsers(rcon, dates = TRUE, labels = TRUE,
  ..., bundle = getOption("redcap_bundle"),
  error_handling = getOption("redcap_error_handling"))

Arguments

rcon

A REDCap connection object as generated by redcapConnection.

...

Arguments to be passed to other methods.

dates

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

labels

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

bundle

A redcap_bundle object.

error_handling

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

Details

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

Value

Returns a data frame. The number of columns in the data frame will depend on your version of REDCap.

The data frame will have one additional column for each form giving the user's form-level permissions in the project. 0=no access, 2=read only, 1=view records/responses and edit records (survey responses are read-only), 3 = edit survey responses

REDCap API Documentation (6.5.0)

This function allows you to export the users for a project

REDCap Version

5.8.2 (Perhaps earlier)

Known REDCap Limitations

None

Author(s)

Benjamin Nutter

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


redcapAPI documentation built on May 12, 2018, 1:05 a.m.