Samples-class {BaseSpaceR} | R Documentation |
Samples
and SamplesSummary
objects Classes and methods to handle the Samples resource.
In general samples are the result of demultiplexing and are thought as the holding the input data for an App. One example of data within a Samples resource are the FASTQ files.
listSamples(x, projectId, ...)
lists all the available samples
associated with a particular project. It returns a small summary for
each existing sample.
is an AppAuth
object.
the ID of the project we want to explore.
Parameters supported by the REST API, specified as
name = value
.
For example, listSamples(x, projectId = "1", Limit = 2)
listSamples(x, ...)
is an Projects
object.
Parameters supported by the REST API.
Samples()
:
Instantiates an empty Samples
object. Same as new("Samples")
.
Samples(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.
Samples(x)
:
x
is an SamplesSummary
object.
Adrian Alexa
https://developer.basespace.illumina.com/docs/content/documentation/rest-api/api-reference
data(aAuth) ## list all the available projects and select one p <- Projects(listProjects(aAuth, Limit = 1), simplify = TRUE) p ## list the samples available in this project allS <- listSamples(aAuth, projectId = Id(p)) ## we can call listSamples() directly using 'p' identical(allS, listSamples(p)) oneS <- listSamples(aAuth, projectId = Id(p), Limit = 1) oneS Samples(oneS) # list with one Samples object Samples(oneS, simplify = TRUE) # Samples object