Overview
mzml2isa is a Python3 program that can be used to generate an ISA-Tab structure out of mzML files, providing the backbone of a study which can then be edited with an ISA editing tool (see MetaboLights pre-packaged ISA Creator)
Currently the program does the following * Extract meta information from mzML files and store as either python dictionary or JSON format * Create an ISA-Tab file structure with relevant meta information * Add additional metadatas that cannot be parsed from mzML files to the ISA-Tab files through a JSON formatted dictionnary.
Install
With PIP
If pip is installed, it can be used to easily install the parser (this may need to be run as administrator depending on the machine’s architecture):
pip3 install mzml2isaWithout PIP
Alternatively, you can also clone the repository and install from the source :
git clone git://github.com/althonos/mzml2isa && cd mzml2isa
python3 setup.py installmzml2isa has 2 optional dependencies: progressbar2 and lxml, the latter quickening the parsing process while the other enhances the output of the program. To install them both, use pip:
pip3 install lxml progressbar2Use
CLI
The parser comes with a simple one-liner:
mzml2isa -i /path/to/mzml_files/ -o /path/to/out_folder/ -s name_of_studyModule
It is also possible to import the package:
from mzml2isa import parsing
in_dir = "/path/to/mzml_files/"
out_dir = "/path/to/out_folder/"
study_identifier_name = "name_of_study"
parsing.full_parse(in_dir, out_dir, study_identifier_name)Meta extraction
If you just want to extract meta information:
from mzml2isa import mzml
onefile = os.path.join(in_dir,"samp1.mzML")
mm = mzml.mzMLmeta(onefile)
# python dictionary format
print mm.meta
# JSON format
print mm.meta_jsonMetabolights
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.shto mount the database to the example directory and start converting mzML studies.
Workflow
Ref
A modified version of the ontology extraction from this blog[1]_ was used, and a slightly modified class from pymzml[2]_
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mzml2isa-0.4.11.tar.gz.
File metadata
- Download URL: mzml2isa-0.4.11.tar.gz
- Upload date:
- Size: 124.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6f2d3ac5886253ea1f51bc07b7ce89daca6dc562248e83215f912790f45c9810
|
|
| MD5 |
9253bfc21917008aa275af28384c2e82
|
|
| BLAKE2b-256 |
ff5131e4d8f70f257d09c7e9f227080ff035406c7dbfc64aeb8a35d8c89d18a4
|
File details
Details for the file mzml2isa-0.4.11-py3-none-any.whl.
File metadata
- Download URL: mzml2isa-0.4.11-py3-none-any.whl
- Upload date:
- Size: 135.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8ff1241d513592ea8b3b20d892fe5dad66648b83896a96ea9ba51d0dc1f19fa1
|
|
| MD5 |
dcab03b542fcf1e2205673fb99de3743
|
|
| BLAKE2b-256 |
0b9a4e57f0c843a45217340821daf1c133cad32774321739f442ca7e71676a95
|
