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
Metadata
Release files for lamps 1.0.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| lamps-1.0.4.tar.gz | 7.2 MB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| lamps-1.0.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 14.4 MB
Release files / lamps-1.0.4.tar.gz
| Download URL | lamps-1.0.4.tar.gz |
|---|---|
| Size | 7.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
54becc49448cbd09807c12400a9ae0a7618238fdf2eb9fa8b70fd268f31711f1
|
|
BLAKE2b-256 checksum How to use checksums |
138bc5e0a453a6a780bc201e468357c959866d20fed41e0eccf9db124933c009
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.7
|
Release files / lamps-1.0.4-py3-none-any.whl
| Download URL | lamps-1.0.4-py3-none-any.whl |
|---|---|
| Size | 7.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
21037779f90b1bfce14a0a0418d8c9d8cee9d5db08e4ecb0f5f26cc74d7f37a8
|
|
BLAKE2b-256 checksum How to use checksums |
d2c6508596300997a6b2b3742618464a79b872a617cea6173c5820a633f84ba1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.7
|
Security for lamps 1.0.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.