getMetadata: Get all Study, Sample and Analysis metadata for the supplied...

In beadyallen/MGnifyR: R interface to EBI MGnify metagenomics resource

Get all Study, Sample and Analysis metadata for the supplied analyses accessions

Description

Get all Study, Sample and Analysis metadata for the supplied analyses accessions

Usage

getMetadata(x, ...)

## S4 method for signature 'MgnifyClient'
getMetadata(x, accession, ...)

Arguments

x	A MgnifyClient object.
...	Optional arguments; not currently used.
accession	A single character value or a vector of analysis accession IDs specifying accessions to retrieve data for.

Details

The function retrieves all associated study, sample and analysis metadata attributes as a list of analyses accessions.

Value

data.frame of metadata for each analysis in the accession list.

Examples

# Create a client object
mg <- MgnifyClient(useCache = FALSE)

# Download all associated study/sample and analysis metadata
accession_list <- c("MGYA00377505")
meta_dataframe <- getMetadata(mg, accession_list)

beadyallen/MGnifyR documentation built on March 30, 2024, 4:48 a.m.