Skip to main content

GitHub Workflow Status GitHub PyPI Documentation Status

MEMO

https://github.com/mandelbrot-project/memo_publication_examples/blob/main/docs/memo_logo.jpg

Description

Ms2 basEd saMple vectOrization (MEMO) is a method allowing a Retention Time (RT) agnostic alignment of metabolomics samples using the fragmentation spectra (MS2) of their consituents. The occurence of MS2 peaks and neutral losses (to the precursor) in each sample is counted and used to generate an MS2 fingerprint of the sample. These fingerprints can in a second stage be aligned to compare different samples. Once obtained, different filtering (remove peaks/losses from blanks for example) and visualization techniques (MDS/PCoA, TMAP, Heatmap, …) can be used. MEMO suits particularly well to compare chemodiverse samples, ie with a poor features overlap, or to compare samples with a strong RT shift, acquired using different LC methods or even different mass spectrometers technology (Maxiis Q-ToF vs Q-Exactive).

Documentation

For documentation, see our readthedocs. Different examples of application and comparison to other MS/MS based metrics are available here and the corresponding notebooks are available on GitHub.

Publication

If you use MEMO, please cite the following papers:
  • MEMO preprint - MEMO: Mass Spectrometry-based Sample Vectorization to Explore Chemodiverse Datasets Arnaud Gaudry, Florian Huber, Louis-Felix Nothias, Sylvian Cretton, Marcel Kaiser, Jean-Luc Wolfender, Pierre-Marie Allard bioRxiv 2021.12.24.474089; doi: https://doi.org/10.1101/2021.12.24.474089

  • Huber, Florian, Stefan Verhoeven, Christiaan Meijer, Hanno Spreeuw, Efraín Castilla, Cunliang Geng, Justin van der Hooft, et al. 2020. “Matchms - Processing and Similarity Evaluation of Mass Spectrometry Data.” Journal of Open Source Software 5 (52): 2411. https://doi.org/10.21105/joss.02411

  • Huber, Florian, Lars Ridder, Stefan Verhoeven, Jurriaan H. Spaaks, Faruk Diblen, Simon Rogers, and Justin J. J. van der Hooft. 2021. “Spec2Vec: Improved Mass Spectral Similarity Scoring through Learning of Structural Relationships.” PLoS Computational Biology 17 (2): e1008724. https://doi.org/10.1371/journal.pcbi.1008724

Installation :

First make sure to have anaconda installed.

B) Alternatively: clone and install locally

B.1. First clone the repository using git clone in command line:

git clone https://github.com/mandelbrot-project/memo.git # or ssh

B.2. Create a new conda environment to avoid clashes:

conda create --name memo python=3.8
conda activate memo

B.3. Install the package locally using pip

pip install .

Run example notebook

It is located in the tutorial folder

You can also find a list of notebook to reproduce results of the MEMO paper. The repo is over there https://github.com/mandelbrot-project/memo_publication_examples

Documentation for developers

Installation

Create an environment with

git clone https://github.com/mandelbrot-project/memo.git
cd memo
conda create --name memo-dev python=3.8
conda activate memo-dev

Then install dependencies and memo:

python -m pip install --upgrade pip
pip install numpy
pip install --editable .[dev]
# pip install -e .'[dev]' (on mac)

Run tests

Memo tests can be run by:

pytest

And the code linter with

prospector

License

MEMO is licensed under the GNU General Public License v3.0. Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights.

Metadata

Release files for memo-ms 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for memo-ms 0.1.4
File Size Uploaded Provenance
memo_ms-0.1.4.tar.gz 26.8 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for memo-ms 0.1.4
File Interpreter ABI Platform
memo_ms-0.1.4-py3-none-any.whl Python 3 none any Details

Total release size: 50.9 kB

Release files / memo_ms-0.1.4.tar.gz

Download URL memo_ms-0.1.4.tar.gz
Size 26.8 kB
Tags Source
SHA-256 checksum
How to use checksums
a90dffb138e430cbd07d042c7b0ec10b5e774e93eb96a156b320dc96b30e8095
BLAKE2b-256 checksum
How to use checksums
26cb5baecd1b4bbfda511dc87b92f8d9580bd570cf2896cb58b2ffecabc41d3c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

Release files / memo_ms-0.1.4-py3-none-any.whl

Download URL memo_ms-0.1.4-py3-none-any.whl
Size 24.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c876208807143d7180dd94b012daf2175514a8a4529496e96b2478516809821e
BLAKE2b-256 checksum
How to use checksums
b0112313dd53b0f9039b7deb65f4d54d9cafe365ce7fccd8d8347ca89a01b54b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.10

Security for memo-ms 0.1.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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page