Skip to contents

This function creates a new root folder in a given repository.

Usage

create_root_folder(name, type, url = getOption("integral_url"), ...)

Arguments

name

A character string specifying the name of the root folder to create in the remote Integral repository.

type

A character string specifying the type of root folder to create. See get_folder_types for available folder types configured with your Integral account.

url

A character string representing the base URL of the Integral repository. Defaults to getOption("integral_url").

...

Additional arguments to include in the body of the request.

Value

A list where each element contains information from the response.

Details

The function makes an HTTP request to a predefined URL. The request includes a header with an encoded API key, and a data body. The response is then processed to create a new root folder in a remote Integral repository.

Examples

if (FALSE) { # \dontrun{
create_root_folder(
 name = "My root folder", 
 type = "Study"
)
} # }