Parser to extract meta information from mzML mass spectrometry files and parse relevant information to a ISA-Tab structure

Version Py versions Git Bioconda Build Status License RTD doc DOI

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)

Currently the program does the following:

  • Extract meta information from mzML files and stores it as either python dictionary or JSON format

  • Creates 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.

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: Thomas Lawson, Martin Larralde

License

GNU General Public License v3 (GPLv3) (GPLv3)

Tags

Metabolomics

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-0.4.29.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

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

mzml2isa-0.4.29-py3-none-any.whl (151.0 kB view details)

Uploaded Python 3

File details

Details for the file mzml2isa-0.4.29.tar.gz.

File metadata

  • Download URL: mzml2isa-0.4.29.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for mzml2isa-0.4.29.tar.gz
Algorithm Hash digest
SHA256 f47d402c23303b4e860fa3eb3b9efc32ca9ea683cae94d66ff7e5767add143d0
MD5 6ef46bb1c4983302776d72e09774965f
BLAKE2b-256 9001335b75a83e1e01e5c69f6fe418c29d16e41127a712f88c83cda2067b16ce

See more details on using hashes here.

File details

Details for the file mzml2isa-0.4.29-py3-none-any.whl.

File metadata

File hashes

Hashes for mzml2isa-0.4.29-py3-none-any.whl
Algorithm Hash digest
SHA256 e14d7f2f0d0d9810299f37513000214d51145f8fb4f1dfebc7734dffe808c086
MD5 8225d10e9845bfe77670640950e1efc2
BLAKE2b-256 174e70c35cacf1c1f13dce9b338fc7e9d04944dbe144f17e87a5f4dab423380f

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