redcapAPI (version 2.10.0)

switchDag: Switch Data Access Group Assignment for the Current User

Description

This method enables the current API user to switch (assign/reassign/unassign) their current Data Access Group assignment if they have been assigned to multiple DAGs via the DAG Switcher page in the project.

Usage

switchDag(rcon, dag, ...)
# S3 method for redcapApiConnection
switchDag(rcon, dag, ...)

Value

Invisibly returns TRUE when the call is completed successfully. Otherwise an error is thrown.

Arguments

rcon

A redcapConnection object.

dag

character(1) A unique data access group to which to assign the current user. Use NA to leave the user unassigned.

...

Arguments to pass to other methods

See Also

exportDags(),
importDags(),
deleteDags(),
exportUserDagAssignments(),
importUserDagAssignments()

Examples

if (FALSE) {
unlockREDCap(connections = c(rcon = "project_alias"), 
             url = "your_redcap_url", 
             keyring = "API_KEYs", 
             envir = globalenv())

# Switch the current user to the DAG "Facility Two"
switchDag(rcon, 
          dag = "facility_two")
}