Skip to main content

Metabolomics Integrator (Mint)

Project description

Python package CII Best Practices CodeQL Language grade: Python

ms-mint

A Python library for large-cohort metabolomics (MS1) processing

The Metabolomics Integrator (MINT) is a post-processing tool for liquid chromatography-mass spectrometry (LCMS) based metabolomics. Metabolomics is the study of all metabolites (small chemical compounds) in a biological sample e.g. from bacteria or a human blood sample. The metabolites can be used to define biomarkers used in medicine to find treatments for diseases or for the development of diagnostic tests or for the identification of pathogens such as methicillin resistant Staphylococcus aureus (MRSA). More information on how to install and run the program can be found in the Documentation.

The ms-mint library can be used for targeted metabolomics with large amounts of files (1000+). It uses a target list and the MS-filenames as input.

News

MINT has been split into the Python library and the app. This repository contains the Python library. For the app follow this link.

Contributions

All contributions, bug reports, code reviews, bug fixes, documentation improvements, enhancements, and ideas are welcome. Before you modify the code please reach out to us using the issues page.

Code standards

The project follows PEP8 standard and uses Black and Flake8 to ensure a consistent code format throughout the project.

Example usage

%pylab inline
from ms_mint.notebook import Mint
mint = Mint()

mint.ms_files = [
    './input/EC_B2.mzXML',
    './input/EC_B1.mzXML',
    './input/CA_B1.mzXML',
    './input/CA_B4.mzXML',
    './input/CA_B2.mzXML',
    './input/CA_B3.mzXML',
    './input/EC_B4.mzXML',
    './input/EC_B3.mzXML',
    './input/SA_B4.mzML',
    './input/SA_B2.mzML',
    './input/SA_B1.mzML',
    './input/SA_B3.mzML'
]

mint.load_targets('/home/swacker/workspace/ms-mint/tests/data/targets/targets_v0.csv')

mint.targets
>>>   peak_label    mz_mean  mz_width    rt  rt_min  rt_max  intensity_threshold target_filename
    0          1  151.06050         5  None    5.07    5.09                    0  targets_v0.csv
    1          2  216.05040         5  None    3.98    4.39                    0  targets_v0.csv
    2          3  115.00320         5  None    3.45    4.39                    0  targets_v0.csv
    3          4  273.00061         5  None    1.10    2.22                    0  targets_v0.csv

mint.run()

# Use mint.run(output_fn='results')

mint.results
>>>

mint.plot.hierarchical_clustering()

FAQ

What is a target list?

A target list is a pandas dataframe with specific columns.

  • peak_label: str, Label of the peak (must be unique).
  • mz_mean: float, m/z value of the target ion.
  • mz_width: float, width of the peak in [ppm] of the mz_mean value.
  • rt: float (optional), expected time of the peak maximum.
  • rt_min: float, starting time for peak integration.
  • rt_max: float, ending time for peak integration.
  • intensity_threshold: float (>=0), minimum intensity value to include, serves as a noise filter.
  • target_filename: str (optional), name of the target list file.

The target list can be stored as csv or Excel file.

What input files can be used?

ms_mint can be used with mzXML, mzML, mzMLb and experimental formats in .feather and .parquet format.

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

ms-mint-0.1.6.tar.gz (49.4 kB view details)

Uploaded Source

Built Distribution

ms_mint-0.1.6-py3-none-any.whl (35.6 kB view details)

Uploaded Python 3

File details

Details for the file ms-mint-0.1.6.tar.gz.

File metadata

  • Download URL: ms-mint-0.1.6.tar.gz
  • Upload date:
  • Size: 49.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for ms-mint-0.1.6.tar.gz
Algorithm Hash digest
SHA256 1063407c38ba4de6ca40958a18d2577d325b431dc65893c64563067c0a34c3d1
MD5 e6b4f2fba2ae140fffd7df6d131bb4ce
BLAKE2b-256 1a6211f719d7103fa33070c3c5410a46062476ce5d07e70170b3f27abc067d1a

See more details on using hashes here.

File details

Details for the file ms_mint-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: ms_mint-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 35.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for ms_mint-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 385f7cd9503e4fe9d2adc1ab4c9d641b98a7b78466b798d7f75748e06b165050
MD5 43bbe34c8d7a79b0d5cc72d403e49577
BLAKE2b-256 89498d44e7d71ec91dad104644f551798ae8e9fb863967b70eee95b6f5a980a8

See more details on using hashes here.

Supported by

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