doc.MGRAST: Read Documentation for MG-RAST API

In braithwaite/MGRASTer: API Client for the MG-RAST Metagenomics Analysis Server

Description

Display sections of the documentation tree of the MG-RAST API.

Usage

doc.MGRAST(depth=1, head=NULL, stratum=NULL, ...)

Arguments

depth	show this many levels (single integer)
head	show elements beginning only here (character)
stratum	show all subtrees matching this name (string)
...	additional arguments passed to str()

Details

The MG-RAST API is locally represented with as a nested list structure or "tree". This function is a souped-up version of str() to help examine parts of that structure. Usage is best understood through the examples. A length-one character vector is meant by "string", above.

Value

None. Output is printed to the screen, as with str().

Author(s)

Daniel T. Braithwaite

References

http://metagenomics.anl.gov
http://api.metagenomics.anl.gov

See Also

str, call.MGRAST, MGRAST

Examples

##  list resources, then list all requests of all resources
doc.MGRAST()
doc.MGRAST(2)

##  show detail for matrix resource (partial matching works)
doc.MGRAST (head="matrix")
doc.MGRAST (2, "mat")

##  show options for all requests
doc.MGRAST (stratum="options")
doc.MGRAST (2, stratum="options")

##  show options in detail for a specific request
doc.MGRAST (3, c("annot","seq","param","opt"))

##  show return values of all m5nr requests in detail
doc.MGRAST (5, "m5nr", "attributes.data", nchar.max=30)

braithwaite/MGRASTer documentation built on May 13, 2019, 2:28 a.m.