USI Resolver and Displayer for Metabolomics

This tool is meant to be able to show USIs from various sources. It will achieve the following goals:

Enable creation of embeddable images in publications that will link out to viewable/interactable spectrum plots.
3rd party embedding for visualization of spectra that exist in repositories (e.g. MassIVE, PRIDE, PeptideAtlas).
3rd party embedding of QR code.

Supported USI Types:

GNPS Molecular Networking Clustered Spectra
GNPS Spectral Libraries
ProteoXchange Repository Data
MS2LDA Reference Motifs
MassBank Library Spectra
MetaboLights Dataset Spectra
Metabolomics Workbench Dataset Spectra

⚠️ These identifiers are based on draft USI and draft Metabolomics USI identifiers. Thus, they are subject to change, and so for the moment, they will be specified as mzdraft instead of mzspec in the first block. Thank you for your patience and working with us!

Example USI URLs

USI Extended for Metabolomics - Formatting Documentation

Massbank Library Spectrum

mzspec:MASSBANK::accession:<MassBank Accession>

GNPS Analysis Task Spectrum

mzspec:GNPS:TASK-<GNPS Task ID>-<File name in task>:scan:<scan number>

MS2LDA MOTIFDB

mzspec:MOTIFDB::accession:<Motif DB accession>

GNPS Library Spectrum

mzspec:GNPS:<GNPS library name (ignored)>:accession:<GNPS Library Accession>

Metabolights Data Repository Spectrum

mzspec:<MetaboLights MSV identifier>:<Filename>:scan:<Scan Number>

Metabolomics Workbench Data Repository Spectrum

mzspec:<Metabolomics Workbench MSV identifier>:<Filename>:scan:<Scan Number>

MassIVE/GNPS Data Repository Spectrum

See Proteomics USI Standard

Example Formatting Figures

Vanilla Rendering

Small Figure

Mass Range Filtering

Zoom Intensity

No Grid

No Peak Annotations

Custom Peak Annotations

Less Decimal Places

Rotate Labels

Decrease Label Minimum Intensity

Vanilla Mirror Match

Mirror Match with Intensity Scaling

Custom Title

Plotting Parameters

mz_min: Minimum m/z value.
mz_max: Maximum m/z value.
annotate_peaks: Defines which peaks in which spectrum (top or bottom) will be annotated. The parameters is a list of lists of m/z values of the peaks to be annotated. For a single spectrum plot it should be a single nested list (i.e. [[m1, m2]]), for a mirror plot it should be two nested lists for the top spectrum and the bottom spectrum (i.e. [[s1m1,s1m2],[s2m1,s2m2]]).
plot_title: Custom plot title, omit to use default

URL Endpoints

/png/
/svg/
/json/
/proxi/v0.1/spectra
/csv/
/qrcode/
/spectrum/
/mirror/
/svg/mirror
/png/mirror

Development

Unit Testing

To run unit tests

export PYTHONPATH=${PYTHONPATH}:.
pytest -v -n 4 ./test/

mwang87/MetabolomicsSpectrumResolver

USI Resolver and Displayer for Metabolomics

Example USI URLs

MS2LDA

MOTIFDB

GNPS Task Spectra for file

GNPS Task Spectra for collection

MassIVE Task Spectra for file

MassIVE Task Spectra for collection

GNPS Library Spectra

MassBank Library Spectra

ProteomeXchange Repository Data

MassIVE/GNPS Repository Data

MassIVE/GNPS MS1 Spectra

MetaboLights Repository Data

Metabolomics Workbench Repository Data