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

Uploaded Python 2Python 3

File details

Details for the file mzml2isa-1.0.0.zip.

File metadata

  • Download URL: mzml2isa-1.0.0.zip
  • Upload date:
  • Size: 151.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for mzml2isa-1.0.0.zip
Algorithm Hash digest
SHA256 b83f549b4746e69d161fcf884139a9c2c0b65df127e32d47382c464055cfbecc
MD5 1badac448bc10884303189dbb3930b27
BLAKE2b-256 c6fc34279b08bc795e7942daea720308d0c145f4d3efff7a697189352fdb181b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mzml2isa-1.0.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 158.5 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.7.0

File hashes

Hashes for mzml2isa-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 9e4806860997ddb22bbd5fbaedf6ee28205ca21db8894fb5f6a5bdcacad9ee18
MD5 09ffa13313aa4e5334e8713dfb293168
BLAKE2b-256 0eafeab78adb629773e8b43596308510e11a0a60181321c024fd47a1cf0650d7

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