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

In MG-RAST/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 https://mg-rast.org 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

https://mg-rast.org
https://api.mg-rast.org

See Also

call.MGRAST

Examples

auth.MGRAST("j6FNL61ekNarTgqupMma6eMx5")
auth.MGRAST(file=system.file("extdata", "my_file.txt", package = "MGRASTer"))
auth.MGRAST()

MG-RAST/MGRASTer documentation built on May 17, 2019, 11:14 p.m.