dagMethods: Export, Import, Delete Data Access Groups from a Project
In nutterb/redcapAPI: Interface to 'REDCap'

dagMethods

R Documentation

Export, Import, Delete Data Access Groups from a Project

Description

These methods enable the user to export existing Data Access Groups, import new Data Access Groups, or delete Data Access Groups from a project.

Usage

exportDags(rcon, ...)

importDags(rcon, data, ...)

deleteDags(rcon, dags, ...)

## S3 method for class 'redcapApiConnection'
exportDags(
  rcon,
  ...,
  error_handling = getOption("redcap_error_handling"),
  config = list(),
  api_param = list()
)

## S3 method for class 'redcapApiConnection'
importDags(
  rcon,
  data,
  refresh = TRUE,
  ...,
  error_handling = getOption("redcap_error_handling"),
  config = list(),
  api_param = list()
)

## S3 method for class 'redcapApiConnection'
deleteDags(
  rcon,
  dags,
  refresh = TRUE,
  ...,
  error_handling = getOption("redcap_error_handling"),
  config = list(),
  api_param = list()
)

Arguments

`rcon`	A `redcapConnection` object.
`dags`	`character` vector of names matching the `unique_group_name`.
`data`	A `data.frame` with two columns: `data_access_group_name` and `unique_group_name`.
`refresh`	`logical(1)`. When `TRUE`, cached data access group data will be refreshed after the import.
`...`	Arguments to pass to other methods
`error_handling`	`character(1)`. One of `c("error", "null")`. An option for how to handle errors returned by the API. see `redcapError()`.
`config`	A named `list`. Additional configuration parameters to pass to `httr::POST()`. These are appended to any parameters in `rcon$config`.
`api_param`	A named `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`.

Details

To import new data access groups, the user must provide a value for data_access_group_name with no value (NA) for unique_group_name.

To modify a group name, provide a new value for data_access_group_name with the associated unique_group_name. If unique_group_name is provided, it must match a value currently in the project.

Value

exportDags with the columns


`data_access_group_name`	The human readable name for the data access group.
`unique_group_name`	The internal unique group name.
`data_access_group_id`	The internal numeric identifier.

importDags invisibly returns the number of Data Access Groups imported.

deleteDags invisibly returns the number of Data Access Groups deleted.

Functions

exportDags(): Export Data Access Groups from a REDCap Project
importDags(): Import Data Access Groups to a project.
deleteDags(): Delete Data Access Groups from a project.

Examples

## Not run: 
unlockREDCap(connections = c(rcon = "project_alias"), 
             url = "your_redcap_url", 
             keyring = "API_KEYs", 
             envir = globalenv())

exportDags(rcon)


# Import a new Data Access Group
NewData <- data.frame(data_access_group_name = "New DAG Name", 
                      unique_group_name = NA_character_)
importDags(rcon, 
           data = NewData)
           
# Modify an existing Data Access Group Name
# The user will need to match the unique_group_name to the existing DAGs
ChangeData <- data.frame(data_access_group_name = "Altered DAG Name", 
                         unique_group_name = "new_dag_name")
importDags(rcon, 
           data = ChangeData)
           
# Delete a Data Access Group
deleteDags(rcon, 
           dags = c("new_dag_name"))

## End(Not run)

nutterb/redcapAPI documentation built on Feb. 11, 2024, 11:20 p.m.