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 analysis accessions

Description

Get all study, sample and analysis metadata for the supplied analysis 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 study, sample and analysis metadata associated with provided analysis accessions.

Value

A data.frame containing metadata for each analysis in the accession list. Each row represents a single analysis.

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 Nov. 3, 2024, 4:23 p.m.