matR (version 0.9.1)

metadata.character: Get metadata of projects and metagenomes

Description

Get metadata of projects or metagenomes specified by ID, or simply look up correspondence of project and metagenome IDs.

Usage

# S3 method for character
metadata(x, detail=NULL, ..., quiet=TRUE, file)

Arguments

x

IDs of projects or metagenomes (character)

detail

level of metadata detail (NULL, TRUE, or character)

…

arguments to call.MGRAST()

quiet

suppress messages and warnings? (logical)

file

file containing project or metagenome IDs (string)

Value

A list (for projects) or vector (for metagenomes) when detail=NULL. Otherwise, a data.frame.

Details

Complete technical documentation is forthcoming. For the current preliminary release, please refer to the examples provided.

See Also

dir.MGRAST, search.MGRAST, biomRequest, MGRASTer::call.MGRAST

Examples

# NOT RUN {
####  three levels of detail for project metadata
xx <- "mgp21 mgp24 mgp30"
metadata (xx)
metadata (xx, detail=TRUE)
names (metadata (xx, detail="verbose"))

####  similar (but not identical) for metagenome metadata
yy <- "mgm4440066.3 mgm4440062.3 mgm4440055.3 mgm4441681.3 mgm4440463.3 mgm4440464.3"
metadata (yy)
metadata (yy, detail=TRUE)
names (metadata (yy, detail="metadata"))
# }
# NOT RUN {
####  relevant documentation for underlying API calls
doc.MGRAST (3, head=c('project','instance','parameters','options'))
doc.MGRAST (3, head=c('metagenome','instance','parameters','options'))
# }