Genomes-class: 'Genomes' and 'GenomesSummary' objects

In BaseSpaceR: R SDK for BaseSpace RESTful API

Description

Classes and methods to handle the Genomes resource.

Browsing

listGenomes(x, ...) lists all the available genomes, returning only a small summary for each genome.

x

is an AppAuth object.

...

Parameters supported by the REST API, specified as name = value. For example, listGenomes(aAuth, Offset = 5, Limit = 2)

Constructor

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

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

Genomes(x): x is an GenomesSummary object.

Author(s)

Adrian Alexa

References

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

See Also

AppAuth, Response.

Examples

data(aAuth)

## list all available genomes
g <- listGenomes(aAuth)
g$SpeciesName

## using the REST API query parameters
listGenomes(aAuth, Limit = 2)
g <- listGenomes(aAuth, Offset = 5, Limit = 2, SortBy = "Build")
g

## get the details for the listed geneomes
Genomes(g)

## get the genomes based on their ID
Genomes(aAuth, id = 4)
## if the ID is missing thean NULL is returned for that particular ID
Genomes(aAuth, id = c(4, 1, 110))

BaseSpaceR documentation built on Nov. 8, 2020, 5:12 p.m.