Skip to main content

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

Version Py versions Git Bioconda Build Status (Travis) 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

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.0.2.zip (163.8 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.0.2-py2.py3-none-any.whl (158.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mzml2isa-1.0.2.zip.

File metadata

  • Download URL: mzml2isa-1.0.2.zip
  • Upload date:
  • Size: 163.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for mzml2isa-1.0.2.zip
Algorithm Hash digest
SHA256 9e68d51a9498bf79caedd1221ed5c2cb73a392059877c6d5e6bd67a1e4ca49e3
MD5 6f71b716aeb1c7306b5bda0c0439442f
BLAKE2b-256 2a844cbb682f0d13f2d74e04f905ff41194c911063acb52e42ed95d3eba0d2da

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mzml2isa-1.0.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 158.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.1

File hashes

Hashes for mzml2isa-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 68889191ffe7f5ef567becede0759dcf133ae858a916141c9778770a4309c2e1
MD5 987b1ced0be4dee4b5af16e5dd9a73c8
BLAKE2b-256 7c07e15adb06e7b4200d2794f63c9b3cad9600ae51343c63857772a5724c3838

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