client-api_r

RSirius

REST API that provides the full functionality of SIRIUS and its web services as background service. It is intended as entry-point for scripting languages and software integration SDKs.

Installation & Usage

conda install (preferred)

Install the r-sirius-ms package from conda-forge using

conda install -c conda-forge r-sirius-ms

or

conda install conda-forge::r-sirius-ms

This will automatically install all dependencies, including the sirius-ms package including SIRIUS itself and set an environment variable for SIRIUS when activating the respective conda environment. The conda-forge install is the preferred method due to quality-of-life features (see Getting Started).

install using remotes library

Specific Version

Replace v0.0.0 with your api version

library(remotes)
install_github(repo = "sirius-ms/sirius-client-openAPI@v0.0.0", subdir = "client-api_r/generated", ref = "master", build = TRUE)

Latest (unstable) Version

library(remotes)
install_github(repo = "sirius-ms/sirius-client-openAPI", subdir = "client-api_r/generated", ref = "master", build = TRUE)

Then import the package:

library('Rsirius') 

Getting Started

Being updated! Coming soon...

SiriusSDK class

For more niche functionality and insights, find the SiriusSDK class here.

Example code

Our feedstocks for the conda-forge packages are running an automated minimal test. We included the scripts here. Feel free to take them as example usages of the packages.

Documentation for API Endpoints

Please click here

Documentation For Models

Please click here