doc.MGRAST: Documentation for MG-RAST API
In MGRASTer: API Client for the MG-RAST Server of the US DOE KBase

Description Usage Arguments Details Value Author(s) References See Also Examples

A utility to flexibly inspect the documentation tree of the MG-RAST API.

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

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

This documentation assumes familiarity with the MG-RAST API, which is described elsewhere.

The MG-RAST API is locally represented with nested lists that this function helps to explore. It is a specialized version of str(). Usage is best understood through the examples.

A length-one character vector is meant by "string", above.

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

Daniel T. Braithwaite

http://metagenomics.anl.gov
http://api.metagenomics.anl.gov
http://www.json.org

str, call.MGRAST, parse.MGRAST, MGRASTAPI

##  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, head="mat")

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

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

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