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 (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

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

Uploaded Python 2Python 3

File details

Details for the file mzml2isa-1.0.4.zip.

File metadata

  • Download URL: mzml2isa-1.0.4.zip
  • Upload date:
  • Size: 164.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for mzml2isa-1.0.4.zip
Algorithm Hash digest
SHA256 54ec89a26820018bc15b7c3a77a8d0c959e213339793f9481bc8904a87d20c51
MD5 fb79b68bf2714fa75063d97af3b67a93
BLAKE2b-256 34e2a65e54667429386fc0557ce4b5459edb166a6f70a06a389891aa7c180c73

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mzml2isa-1.0.4-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.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for mzml2isa-1.0.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5035518622ee51ab3e45cab97673415ad5da6a2d93e05960edbb3ae9e3bfdaf3
MD5 873b9c21a5a790bc8f22a8c9668b8102
BLAKE2b-256 daabe452d45c117533698743937cf0573987bbabae91c270419163759322e2f5

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