Liverpool Annotation of metabolites using Mass Spectrometry
Project description
LAMP - Liverpool Annotation of metabolites using Mass sPectrometry
Introduction
Untargeted metabolomics studies routinely apply liquid chromatography-mass spectrometry to acquire data for hundreds or low thousands of metabolites and exposome-related (bio)chemicals. The annotation or higher-confidence identification of metabolites and biochemicals can apply multiple different data types (1) chromatographic retention time, (2) the mass-to-charge (m/z) ratio of ions formed during electrospray ionisation for the structurally intact metabolite or (bio)chemical and (3) fragmentation mass spectra derived from MS/MS or MS^n^ experiments.
Commonly, the mass-to-charge (m/z) ratio of ions formed during electrospray ionisation for the structurally intact metabolite are applied as a first step in the annotation process. Importantly, a single metabolite can be detected as multiple different ion types (adducts, isotopes, in-source fragments, oligomers) and grouping together of features representing the same metabolite or biochemical can decrease the number of false positive annotations. The Liverpool Annotation of metabolites using Mass sPectrometry (LAMP) is a Python package and an easy-to-use software for feature grouping and metabolite annotation using MS1 data only. LAMP groups features based on chromatographic retention time similarity and positive response-based correlations across multiple biological samples. Genome-scale metabolic models are the source of metabolites applied in the standard reference files though any source of metabolites can be used (e.g. HMDB or LIPIDMAPS). The m/z differences related to in-source fragments, adducts, isotopes, oligomers and charge states can be user-defined in the reference file.
Installation
PyPI
To install from PyPI via pip, use the distribution
name lamps:
pip install lamps
This is the preferred installation method.
Conda
LAMP is in Bioconda channel and use the following to install for conda:
conda install -c bioconda lamps
Source
Install directly from GitHub:
pip install git+https://github.com/wanchanglin/lamp.git
Update directly from GitHub branch dev:
pip install git+https://github.com/wanchanglin/lamp.git@dev --upgrade --no-deps --force-reinstall
Usages
For end users, LAMP provides command line and graphical user interfaces.
$ lamp --help
Executing lamp version 1.0.4.
usage: lamp [-h] {cli,gui} ...
Compounds Annotation of LC-MS data
positional arguments:
{cli,gui}
cli Annotate metabolites in CLI.
gui Annotate metabolites in GUI.
options:
-h, --help show this help message and exit
Command line interface (CLI)
Use the follow command line to launch CLI mode: :
$ lamp cli <arg_lists>
Here is an example: :
lamp cmd \
--sep "tab" \
--input-data "./data/df_pos_3.tsv" \
--col-idx "1, 2, 3, 4" \
--add-path "" \
--ref-path "" \
--ion-mode "pos" \
--cal-mass \
--thres-rt "1.0" \
--thres-corr "0.5" \
--thres-pval "0.05" \
--method "pearson" \
--positive \
--ppm "5.0" \
--save-db \
--save-mr \
--db-out "./res/test.db" \
--sr-out "./res/test_s.tsv" \
--mr-out "./res/test_m.tsv"
Graphical user interface (GUI)
$ lamp gui
Links
- Documentation: Read the Docs
- PyPI: https://pypi.org/project/lamps/
- Bioconda: https://anaconda.org/bioconda/lamps
- DOI: 10.5281/zenodo.14711459
Authors
- Wanchang Lin (Wanchang.Lin@liverpool.ac.uk), The University of Liverpool
- Warwick Dunn (Warwick.Dunn@liverpool.ac.uk), The University of Liverpool
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file lamps-1.0.4.tar.gz.
File metadata
- Download URL: lamps-1.0.4.tar.gz
- Upload date:
- Size: 7.2 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
54becc49448cbd09807c12400a9ae0a7618238fdf2eb9fa8b70fd268f31711f1
|
|
| MD5 |
8a5416afe883c2b8230641d76e8fcdd4
|
|
| BLAKE2b-256 |
138bc5e0a453a6a780bc201e468357c959866d20fed41e0eccf9db124933c009
|
File details
Details for the file lamps-1.0.4-py3-none-any.whl.
File metadata
- Download URL: lamps-1.0.4-py3-none-any.whl
- Upload date:
- Size: 7.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
21037779f90b1bfce14a0a0418d8c9d8cee9d5db08e4ecb0f5f26cc74d7f37a8
|
|
| MD5 |
a88a37b29dd4cc8899e365f015491797
|
|
| BLAKE2b-256 |
d2c6508596300997a6b2b3742618464a79b872a617cea6173c5820a633f84ba1
|