R: Deletes an existing container, which may be a project,...

labkey.security.deleteContainer {Rlabkey} | R Documentation

## Deletes an existing container, which may be a project, folder, or workbook

### Description

Deletes an existing container, which may be a project, folder, or workbook, and all of its children from the Labeky server.

### Usage

    labkey.security.deleteContainer(baseUrl=NULL, folderPath)

### Arguments

`baseUrl` | A string specifying the `baseUrl` for the labkey server.
`folderPath` | A string specifying the `folderPath` to be deleted.

### Details

This function allows for users with proper permissions to delete an existing container, which may be a project, folder, or workbook, from the LabKey server. This will also remove all subfolders of the container being deleted. If the container does not exist or the user does not have permissions, an error message will be returned.

### Value

Returns a success message for the container deletion action.

### Author(s)

Cory Nathe

### See Also

`labkey.getFolders`, `labkey.security.getContainers`, `labkey.security.createContainer`, `labkey.security.moveContainer`

### Examples

    library(Rlabkey)

    labkey.security.deleteContainer(baseUrl="http://labkey/", folderPath = "/home/FolderToDelete")

[Package Rlabkey version 2.8.4 Index]