initInterMine: Initialize the list containing the base URL and API token.

Description Usage Arguments Value Author(s) References Examples

View source: R/InterMineR.R

Description

Initialize the InterMine list with the base URL of the webservice of the database and the API token.

Some resources such as lists are normally privately associated with the individual user that created them and require authentication for access. To access these private resources, each request needs to be authenticated, using an API key token. You can get an API token from the web-app of the service you intend to access: visit the MyMine tab after logging-in and click on API Key.

Usage

1
initInterMine(mine = listMines()["HumanMine"], token="")

Arguments

mine

a string, representing the base URL of the webservice of the database.

token

a string, representing the API token in order to use private functions such as list and enrichment.

Value

A Service object containing the base URL and API token.

Author(s)

InterMine Team

References

/urlhttp://intermine.readthedocs.io/en/latest/web-services/

Examples

1
2
3
#hashed out example as requires API key
#im <- initInterMine(mine = listMines()["HumanMine"], "TOKEN") #replace TOKEN with your token
#class(im)

intermine/InterMineR documentation built on Jan. 10, 2022, 11:34 p.m.