Skip to content

aberHRML/metabolighteR

This branch is up to date with master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Feb 19, 2025
a37aa4b · Feb 19, 2025
Sep 20, 2023
Sep 20, 2023
Feb 19, 2025
Feb 24, 2023
Sep 21, 2023
Nov 18, 2022
Dec 11, 2020
Sep 23, 2020
Feb 26, 2024
Feb 24, 2023
Nov 22, 2022
Nov 18, 2019
Dec 15, 2020
Mar 26, 2019
Nov 18, 2019
Mar 6, 2019

Repository files navigation

metabolighteR

Lifecycle: stable R build status codecov License DOI

CRAN total downloads

GitHub

R Interface to the Metabolights REST API

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()