README.md

In aberHRML/metabolighteR: Interface to the 'Metabolights' REST API

metabolighteR

R Interface to the Metabolights REST API

• Installation
• Creating an API Key

Installation

metabolighteR can be installed from CRAN using;

install.packages('metabolighteR')

Or the latest development version can be installed directly from GitHub using the remotes package

remotes::install_github('aberHRML/metabolighteR')

Creating an API Key

Some of the API methods (ie, accessing your private studies) require a personal API token. To generate a token you first need to register and then obtain an API Token from your Account Settings page.

This API Token is not required for the vast majority of the API calls for querying publicly available studies.

If you are adding the API Token to your .Renviron, you should use the following format;

NOTE: this is NOT recommended if you are using a shared workstation or a workstation where you cannot guarantee the secrecy of your API Token

MTBLS_API_KEY="<your-api-token-here>"

Then once you load the library; you can set the API Token as an option variable.

library(metabolighteR)

mtbls_key()

aberHRML/metabolighteR documentation built on March 1, 2024, 7:31 a.m.