matR (version 0.9)

dir.MGRAST: List directory of projects

Description

Get full or partial directory listing of projects, with minimal or detailed metadata per project.

Usage

dir.MGRAST(from, to, length.out=0, ..., quiet=TRUE)

Arguments

from

starting index for returned results (numeric)

to

ending index for returned results (numeric)

length.out

number of results to return; default zero means all (numeric)

...

arguments to call.MGRAST()

quiet

suppress messages and warnings? (logical)

Value

A data.frame of project information.

Details

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

See Also

search.MGRAST, metadata.character, MGRASTer::call.MGRAST

Examples

## Not run: 
# ####  names of all public projects
# dir.MGRAST()$name
# 
# ####  ids of all public projects
# rownames (dir.MGRAST())
# 
# ####  investigators who have contributed public projects
# unique (dir.MGRAST()$pi)
# 
# ####  first 25 projects submitted to MG-RAST
# dir.MGRAST (len=25, order="id")
# 
# ####  detailed information about them
# names (dir.MGRAST(len=25, order="id", verbosity="verbose"))
# 
# ####  quick look at public projects
# strtrim (dir.MGRAST (verbosity="verbose")$description, 70)
# ## End(Not run)

####  relevant documentation for the underlying API call
doc.MGRAST (3, head=c('project','query','parameters','options'))