labkey.security.createContainer: Creates a new container, which may be a project, folder, or...

In Rlabkey: Data Exchange Between R and 'LabKey' Server

Creates a new container, which may be a project, folder, or workbook, on the server

Description

Create a new container, which may be a project, folder, or workbook, on the LabKey server with parameters to control the containers name, title, description, and folder type.

Usage

labkey.security.createContainer(baseUrl=NULL, parentPath, name = NULL, title = NULL,
    description = NULL, folderType = NULL, isWorkbook = FALSE)

Arguments

baseUrl	A string specifying the baseUrl for the labkey server.
parentPath	A string specifying the parentPath for the new container.
name	The name of the container, required for projects or folders.
title	The title of the container, used primarily for workbooks.
description	The description of the container, used primarily for workbooks.
folderType	The name of the folder type to be applied (ex. Study or Collaboration).
isWorkbook	Whether this a workbook should be created. Defaults to false.

Details

This function allows for users with proper permissions to create a new container, which may be a project, folder, or workbook, on the LabKey server with parameters to control the containers name, title, description, and folder type. If the container already exists or the user does not have permissions, an error message will be returned.

Value

Returns information about the newly created container.

Author(s)

Cory Nathe

See Also

labkey.getFolders, labkey.security.getContainers, labkey.security.deleteContainer, labkey.security.moveContainer labkey.security.renameContainer

Examples

## Not run: 

library(Rlabkey)

labkey.security.createContainer(baseUrl="http://labkey/", parentPath = "/home",
    name = "NewFolder", description = "My new folder has this description",
    folderType = "Collaboration"
)


## End(Not run)

Rlabkey documentation built on Nov. 8, 2023, 1:06 a.m.