newProject: Create a new folder

View source: R/projects.R

newProjectR Documentation

Create a new folder

Description

This function creates a new project. You can achieve the same results by assigning into the projects catalog, but this may be a more natural way to think of the action, particularly when you want to do something with the project entity after you create it.

Usage

newProject(name, members = NULL, catalog = projects(), ...)

Arguments

name

character name for the project

members

Optional character vector of emails or user URLs to add as project members.

catalog

ProjectFolder in which to create the new project. There is only one project catalog currently, projects(), but this is left here so that all ⁠new*⁠ functions follow the same pattern.

...

Additional project attributes to set

Value

A ProjectFolder object.

See Also

mkdir()

Examples

## Not run: 
proj <- newProject("A project name")
# That is equivalent to doing:
p <- projects()
p[["A project name"]] <- list()
proj <- p[["A project name"]]

proj2 <- newProject("Another project", members = "you@yourco.com")
# That is equivalent to doing:
p[["Another project"]] <- list(members = "you@yourco.com")
proj <- p[["Another project"]]

## End(Not run)

Crunch-io/rcrunch documentation built on Feb. 25, 2024, 11:50 p.m.