setFlowRepositoryCredentials: Set credentials (email and password) to login to FlowRepository.

Description

This function sets your credentials (email and password) to access FlowRepository. These credentials will than be used to access private datasets that you have access to (i.e., that are either yours or that have been shared with you). The email must correspond to the email that you are using to login to FlowRepository, and the password must correspond to the password that is set for FlowRepository API access in your FlowRepository profile. Click on your name when logged-in to FlowRepository in your web browser in order to setup your API password. This function can set your credetials based on credentials stored in a file (2 lines, email address in the first line, password in the second line), or you can provide email and/or password as arguments of this function, or the function will ask for credentials if called without arguments in an interactive mode.

Usage

setFlowRepositoryCredentials(filename=NULL, email=NULL, password=NULL)

Arguments

filename

The file with credentials. If specified, this argument will take precedence over the email and password arguments (so do not use it together with the email and password arguments). The file is expected to be a text file with 2 lines. The first line is expected to contain the email, the second line the password.

An email address as registered with FlowRepository. Use only if you are not providing a filename. If neither filename, nor email are provided, then the function will ask for email as long as it is executed in an interactive mode.

password

A password as registered for API access with FlowRepository. Use only if you are not providing a filename. If neither filename, nor password are provided, then the function will ask for a password as long as it is executed in an interactive mode.

Value

The return value is not expected to be useful. An empty string (an object of class character with 0 characters).

Details

The credentials are stored locally in an environment within the namespace in the FlowRepositoryR library. Your credentials will be forgotten when you quit your R session, or when you call the forgetFlowRepositoryCredentials function.

References

Spidlen Josef. FlowRepository Resources for Developers. http://flowrepository.org/developers

Examples

Run this code

    ## Let's set credentials
    setFlowRepositoryCredentials(email="boo@gmail.com", password="foo123456")
    ## Now do some work with FlowRepository...
    ## ...
    ## And now let's forget those credentials
    forgetFlowRepositoryCredentials()

Run the code above in your browser using DataLab