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.3.zip (164.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.0.3-py2.py3-none-any.whl (158.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mzml2isa-1.0.3.zip.

File metadata

  • Download URL: mzml2isa-1.0.3.zip
  • Upload date:
  • Size: 164.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.6

File hashes

Hashes for mzml2isa-1.0.3.zip
Algorithm Hash digest
SHA256 172456bdb622067a21e69ac0d1b158828637343078e65ca747435f3839b5f888
MD5 8ed4a3a7e59179c4b3fc35886cd792c5
BLAKE2b-256 8a11b34ebf78f38bbd1b524c75c33ef30e99075622aedaf6ed26afae3e0a43c9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mzml2isa-1.0.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 158.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.1 CPython/3.7.6

File hashes

Hashes for mzml2isa-1.0.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 45186526c95ac514de79b00da0ef53fd700c777474a2899bf833f97963a7b604
MD5 c4e20f9c92869b827e1da35045bd8fd0
BLAKE2b-256 6946c773e19ce6c6b9be7f1ddd3e6a04f00d082734e3464083ba73b966e9a7cd

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