Extract metadata from mzML and imzML files and write them to an ISA-Tab document.

Version Py versions Git Bioconda Build Status (Actions) Build Status (AppVeyor) License RTD doc DOI Paper

Overview

mzml2isa is a Python3 program that can automatically generate ISA-Tab document structure metadata files from raw XML metabolomics data files (mzML open access data format). The mzml2isa tool provides the backbone of ISA-Tab metabolomics study which can then be edited with an ISA editing tool, ISAcreator (see MetaboLights pre-packaged ISA Creator)

Features:

  • Extract meta information from mzML files and stores it as a Python dictionary or serialize it into a JSON formatted document.

  • Create an ISA-Tab file structure with relevant meta information filled in.

  • Add additional metadata that cannot be parsed from mzML files to the ISA-Tab files through a JSON formatted dictionnary or an XLS file.

Install

See the Installation page of the online documentation.

Usage

CLI

mzml2isa -i /path/to/mzml_files/ -o /path/to/out_folder/ -s name_of_study

Python Module

See the Usage page and the Examples page for more information.

Metabolights

To download some real data from MetaboLights studies to test the converter with, run

python scripts/metabolights-dl.py <size>

from inside the repository, where size is the maximum size in GiB you can allocate to download files. The script will download the files to the example_files/metabolights folder and then run mzml2isa on those files..

If you use a *NIX machine with curlftpfs and bash available, you can also run

scripts/metabolights.sh

to mount the database to the example directory and start converting mzML studies.

Workflow

workflow

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.1.1)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for althonos from gravatar.com althonos Avatar for tomnl from gravatar.com tomnl

Credits

Author: Tom Lawson, Martin Larralde

License

GNU General Public License v3 (GPLv3) (GPLv3)

Requires

Python >=3.6

Tags

metabolomics mass spectrometry metabolites ISA Tab mzML parser

Classifiers

Report project as malware

Download files

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

Source Distribution

mzml2isa-1.1.0.zip (311.7 kB view details)

Uploaded Source

Built Distribution

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

mzml2isa-1.1.0-py2.py3-none-any.whl (305.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mzml2isa-1.1.0.zip.

File metadata

  • Download URL: mzml2isa-1.1.0.zip
  • Upload date:
  • Size: 311.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for mzml2isa-1.1.0.zip
Algorithm Hash digest
SHA256 a5f3795304967aaff1642244934ac3cf78cc37705e6fddfd458a414b52a38ae6
MD5 a7e539bc49011829e8a52c2301c806b3
BLAKE2b-256 184b9be602f5521a4f6bebe5807b3df1634f65615c51df8744834e13187f4542

See more details on using hashes here.

File details

Details for the file mzml2isa-1.1.0-py2.py3-none-any.whl.

File metadata

  • Download URL: mzml2isa-1.1.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 305.7 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for mzml2isa-1.1.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 2468e4c28b4604990d34d43c8f75bdbc5fe1d22405829e2a8b9b219af2539f93
MD5 ba2e72de900b81bc35612a7be799b26c
BLAKE2b-256 4cbb527dc093be359193b43111a3d0935d80c42fbcc7a43d8b6c5825de7067fb

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 Sentry Error logging StatusPage Status page