Skip to main content

mzml2isa - mzML to ISA-tab parsing tool

Project description

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 (Travis) Build Status (AppVeyor) 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 details


Release history Release notifications

This version
History Node

0.5.1

History Node

0.5.0

History Node

0.4.29

History Node

0.4.28

History Node

0.4.27

History Node

0.4.26

History Node

0.4.25

History Node

0.4.24

History Node

0.4.23

History Node

0.4.22

History Node

0.4.20

History Node

0.4.19

History Node

0.4.18

History Node

0.4.17

History Node

0.4.16

History Node

0.4.15

History Node

0.4.14

History Node

0.4.13

History Node

0.4.12

History Node

0.4.11

History Node

0.4.10

History Node

0.4.9.8

History Node

0.4.9.7

History Node

0.4.9.6

History Node

0.4.9.5

History Node

0.4.9.4

History Node

0.4.9.3

History Node

0.4.9.2

History Node

0.4.9.1

History Node

0.4.9

History Node

0.4.9a0

History Node

0.4.8

History Node

0.4.8a0

History Node

0.4.7

History Node

0.4.6

History Node

0.4.5

History Node

0.4.4

History Node

0.4.3

History Node

0.4.2

History Node

0.4.1

History Node

0.4.0

History Node

0.3.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
mzml2isa-0.5.1-py3-none-any.whl (267.1 kB) Copy SHA256 hash SHA256 Wheel 3.5 Dec 4, 2016
mzml2isa-0.5.1.tar.gz (1.2 MB) Copy SHA256 hash SHA256 Source None Dec 4, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page