loginMgrast: Login to the MGRAST

Description Usage Arguments Details Value See Also Examples

View source: R/loginMgrast.R

Description

Login to MGRAST, obtain your Websession and webkey for data uploading, as an authenticate of subsequent operation about MGRAST (e.g. data upload, job submission).

Usage

1
loginMgrast(user, userpwd)

Arguments

user

character, username you have registered on MGRAST

userpwd

character, password correspondance to your username

Details

Sequence functional annotation is the most necessary and important step for metagenomic analysis. MGRAST (metagenomics RAST) server is a free and public utomated analysis platform for metagenomes providing quantitative insights into microbial populations based on sequence data, also very fast, stable and extensible. Thus, MGRAST was took for sequence functional annotation in our package mmnet.

Webkey, session and curlhandle would be generated when users login to MGRAST with this function, which is the key for data uploading and sequence annotation.

Value

webkey

character, e.g. "8Dvg2d5DCp7KsWKBPzY2GS4i", the webkey of your account which is essential for data uploding to MGRAST. However, it will be valid for a limited time only (the next value). Users will generate a new webkey with fucntion generateMgrastWebkey for convenient.

invalid.until

character, with corresponding to the webkey, just the limit time of your webkey

cookie

data saved on user's computer while login to MGRAST

session

character, a userid that MGRAST server assigned

curlhandle

class of CURLHandle, the curl handle while users to MGRAST which is saved for user's sebsequent analysis with MGRAST.

See Also

uploadMgrast

Examples

1
2
# need a username and password on MGRAST
# login.info <- loginMgrast("mmnet","mmnet")

Example output

Loading required package: igraph

Attaching package: 'igraph'

The following objects are masked from 'package:stats':

    decompose, spectrum

The following object is masked from 'package:base':

    union

Loading required package: biom

mmnet documentation built on May 31, 2017, 3:25 p.m.