auth.MGRAST: Provide Auth Key to MG-RAST API

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

Description

Provide an auth key for access to private resources using the MG-RAST API.

Usage

auth.MGRAST(key, file)

Arguments

key	value of key (string)
file	file containing key (string)

Details

Accessing private resources with the MG-RAST API requires an auth key. Log in at http://metagenomics.anl.gov to create a key, via "Preferences" on the "Account Management" page. Note you must click not only "generate new key" but also "set preferences"! Also note the key is only valid for a limited time.

The key must be entered during every R session. Call auth.MGRAST() specifying at most one of key or file. To enter the key at an interactive prompt instead, both may be omitted.

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

Value

The key value that has been set.

Author(s)

Daniel T. Braithwaite

References

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

See Also

call.MGRAST

Examples

## Not run: 
auth.MGRAST("j6FNL61ekNarTgqupMma6eMx5")
auth.MGRAST(file="my_key.txt")
auth.MGRAST()

## End(Not run)

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