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.27.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.27-py3-none-any.whl (151.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mzml2isa-0.4.27.tar.gz
Algorithm Hash digest
SHA256 783505d443c12a3176b8c2ef4c067bdfa17ed06864be9df05f8d2d1a4f220776
MD5 0fa86b2531cddb93e57bd6205a1f93f6
BLAKE2b-256 c11b788b3fc77e6240ba8f1e586132ade37eb4fefd9703f683887544097ada9a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mzml2isa-0.4.27-py3-none-any.whl
Algorithm Hash digest
SHA256 1e4f23b5080ed382d36464b3f550d545aa5881a544e4124e824167798124b6bd
MD5 8cfe931a6b38475563d27226f260c5c9
BLAKE2b-256 075004e1eee0f8435042463339d2a0aee728f52b03476008c18047476cb49150

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