Projects-class {BaseSpaceR}R Documentation

Projects and ProjectsSummary objects

Description

Classes and methods to handle the Projects resource.

Details

The Projects resource provides a logical grouping of the Samples resource and the AppResults resource for a given user.

Browsing

listProjects(x, ...) lists all the available projects visable to the user, returning only a small summary for each project.

x

is an AppAuth object.

...

Parameters supported by the REST API, specified as name = value. For example, listProjects(x, Limit = 2)

Constructor

Projects(): Instantiates an empty Projects object. Same as new("Projects").

Projects(x, id): x is an AppAuth object. id is either and integer or a character string storing an integer. id can have length larger that 1.

Projetcs(x): x is an ProjectsSummary object.

Author(s)

Adrian Alexa

References

https://developer.basespace.illumina.com/docs/content/documentation/rest-api/api-reference

See Also

AppAuth, Response, Users and Runs.

Examples

data(aAuth)

p <- listProjects(aAuth)
p

Projects(aAuth, id = c(2, 12, 1012))
Projects(p)


## Make a new project ...
createProject(aAuth, name = "My Project X")


## We need 'write global' access to be able to create a new project
## Not run: 
initializeAuth(aAuth, scope = "write global")
requestAccessToken(aAuth)

createProject(aAuth, name = "My Project X")

## End(Not run)


[Package BaseSpaceR version 1.28.0 Index]