MGRASTer (version 0.9)

doc.MGRAST: Documentation for MG-RAST API

Description

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

Usage

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

Arguments

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()

Value

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

Details

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.

References

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

See Also

str, call.MGRAST, parse.MGRAST, MGRASTAPI

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, 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)