createFileRepositoryFolder function

Create a Folder in the File Repository

This method enables the user to create a folder in the file repository. The folder created may also be a subfolder of an existing folder.

createFileRepositoryFolder(
  rcon,
  name,
  folder_id = numeric(0),
  dag_id = numeric(0),
  role_id = numeric(0),
  ...
)

## S3 method for class 'redcapApiConnection'
createFileRepositoryFolder(
  rcon,
  name,
  folder_id = numeric(0),
  dag_id = numeric(0),
  role_id = numeric(0),
  ...
)

Arguments

• rcon: A redcapConnection object.
• name: character(1) The name of the folder. If a folder by this name already exists, no action will be taken.
• folder_id: integerish(0/1). The ID of the parent folder. When length is 0, the new folder is placed in the top-level.
• dag_id: integerish(0/1) The ID of a data access group. When provided, access to the folder will be restricted to the DAG.
• role_id: integerish(0/1) The ID of a role. When provided, access to the folder will be restricted to users with that role.
• ...: Arguments to pass to other methods

Returns

Returns a data frame with the columns

folder_id	The REDCap assigned ID value for the newly created folder.
name	The name assigned to the folder by the user.

Examples

## Not run:

unlockREDCap(connections = c(rcon = "project_alias"), 
             url = "your_redcap_url", 
             keyring = "API_KEYs", 
             envir = globalenv())
             
# Create a folder in the top-level directory
createFileRepositoryFolder(rcon, 
                           name = "New Folder Name")
                           
# Create a folder in a subfolder
createFileRepositoryFolder(rcon, 
                           name = "New Folder Name", 
                           folder_id = 12345)
                           
# Create a folder assigned to a Data Access Group
createFileRepositoryFolder(rcon, 
                           name = "New Folder Name", 
                           dag_id = 678)
## End(Not run)

See Also

exportFromFileRepository(),

importToFileRepository(),

deleteFromFileRepository(),

exportFileRepository(),

importFileRepository(),

deleteFileRepository(),

exportFileRepositoryListing()