Runs-class {BaseSpaceR}R Documentation

Runs and RunsSummary objects

Description

Classes and methods to handle the Runs resource.

Details

The Runs resource contains the raw data produced by the instruments, the base calls, together with run metrics, instrument health data, and other information used for data processing and analysis.

Browsing

listRuns(x, ...) lists all the available runs visable to the user, returning only a small summary for each run.

x

is an AppAuth object.

...

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

Constructor

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

Runs(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.

Runs(x): x is an RunsSummary object.

Author(s)

Adrian Alexa

References

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

See Also

AppAuth, Response, and Users.

Examples

data(aAuth)

r <- listRuns(aAuth)
r

listRuns(aAuth, Statuses = "Failed") # no faild runs
listRuns(aAuth, Statuses = "Complete")
listRuns(aAuth, SortBy = "Id", SortDir="Desc")

Runs(r)[[1]]


Runs(aAuth, id = 101102)
Runs(r)

Runs(aAuth, id = c(Id(r), "11111")) # the third element must be NULL


[Package BaseSpaceR version 1.24.0 Index]