Skip to main content

Annotate LC-MS1 data, MS imaging data or pseudo MS/MS spectra using reference MS/MS libraries

Project description

ms1_id

Developer PyPI License Python

Full-scan MS data from both LC-MS and MS imaging capture multiple ion forms, including their in/post-source fragments. Here we leverage such fragments to structurally annotate full-scan data from LC-MS or MS imaging by matching against MS/MS spectral libraries.

ms1_id is a Python package that annotates full-scan MS data using tandem MS libraries, specifically:

  • annotate pseudo MS/MS spectra: mgf files
  • annotate LC-MS data: mzML or mzXML files
  • annotate MS imaging data: imzML and ibd files
  • build indexed MS/MS libraries from mgf or msp files (see Flash entropy for more details)

Workflow

Annotation workflow

Example annotations

Example annotation

Installation

pip install ms1_id

Python 3.9+ is required. It has been tested on macOS (14.6, M2 Max) and Linux (Ubuntu 20.04).

Usage

Note: Indexed libraries are needed for the workflow. You can download the indexed GNPS library here.

wget https://github.com/Philipbear/ms1_id/releases/latest/download/indexed_gnps_libs.zip
unzip indexed_gnps_libs.zip -d db

Annotate pseudo MS/MS spectra

If you have pseudo MS/MS spectra in mgf format, you can directly annotate them:

ms1_id annotate --input_file pseudo_msms.mgf --libs db/gnps.pkl db/gnps_k10.pkl --min_score 0.7 --min_matched_peak 3

Here, two indexed libraries are searched against, and the result tsv files will be saved in the same directory as the input file.

For more options, run:

ms1_id annotate --help

Annotate LC-MS data

To annotate LC-MS data, here is an example command:

ms1_id lcms --project_dir lc_ms --sample_dir data --ms1_id_libs db/gnps.pkl db/gnps_k10.pkl --ms2_id_lib db/gnps.pkl

Here, lc_ms is the project directory. Raw mzML or mzXML files are stored in the lc_ms/data folder. Both MS1 and MS/MS annotations will be performed, and the results can be accessed from aligned_feature_table.tsv.

For more options, run:

ms1_id lcms --help

Expected runtime is <3 min for a single LC-MS file. If it takes longer than 10 min, please increase the --mass_detect_int_tol parameter (default: 2e5 for Orbitraps, 5e2 for QTOFs).


Annotate MS imaging data

To annotate MS imaging data, here is an example command:

ms1_id msi --project_dir msi --libs db/gnps.pkl db/gnps_k10.pkl --n_cores 12

Here, msi is the project directory. Raw imzML and ibd files are stored in the msi folder, and 12 cores will be used for parallel processing. Annotation results can be accessed from ms1_id_annotations_derep.tsv

For more options, run:

ms1_id msi --help

Expected runtime <5 min for a single MS imaging dataset.


Build indexed MS/MS libraries

To build your own indexed library, run:

ms1_id index --ms2db library.msp --peak_scale_k 10 --peak_intensity_power 0.5

For more options, run:

ms1_id index --help

Demo

We provide a demo script to prepare the environment, download libraries, download LC-MS data and run the annotation workflow.

bash run.sh

Citation

Shipei Xing, Vincent Charron-Lamoureux, Yasin El Abiead, Huaxu Yu, Oliver Fiehn, Theodore Alexandrov, Pieter C. Dorrestein. Annotating full-scan MS data using tandem MS libraries. bioRxiv 2024.

Data

License

This project is licensed under the Apache 2.0 License (Copyright 2024 Shipei Xing).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ms1_id-0.1.4.tar.gz (179.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ms1_id-0.1.4-py3-none-any.whl (231.8 kB view details)

Uploaded Python 3

File details

Details for the file ms1_id-0.1.4.tar.gz.

File metadata

  • Download URL: ms1_id-0.1.4.tar.gz
  • Upload date:
  • Size: 179.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for ms1_id-0.1.4.tar.gz
Algorithm Hash digest
SHA256 1ea793f95342740d8af2cc4458bea7ac1c9c5717b925f9928a4139122f3a61bd
MD5 6e934fca9949e1724165723e581cbd4a
BLAKE2b-256 607d3432a221e00253cc891f7eeb1650202d38fb6f86955805ce4ae849582cd9

See more details on using hashes here.

File details

Details for the file ms1_id-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: ms1_id-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 231.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.8.18

File hashes

Hashes for ms1_id-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 aed2fe0fe693d7b91ee5e0dacab51066e431bf8a90cbab74e8996002381c0dba
MD5 19c694307c85d28fd008e00590ff04b2
BLAKE2b-256 f78115b24a3a063d8eab44c9ac8048a80db974db12280e593dc0edefbd2e7d9c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page