Skip to main content

Version Py versions Git Build Status License RTD doc

Overview

nmrml2isa is a Python3 program that can be used to generate an ISA-Tab structured investigation out of nmrML files, providing the backbone of a study that can then be edited with an ISA editing tool (see MetaboLights pre-packaged ISA Creator)

Install

See the Installation page of the online documentation.

Use

See the Usage page and the Examples page for more detailed descriptions of usage and examples.

CLI

The parser comes with a simple one-liner:

mzml2isa -i /path/to/nmrml_files/ -o /path/to/out_folder -s name_of_study

Module

It possible to import nmrml2isa as a Python module:

from nmrml2isa import parsing

in_dir = "/path/to/nmrml_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 the meta information without writing them in ISA-Tab files, it is possible to do so either by running the nmrml2isa.nmrml module as main:

python -m nmrml2isa.nmrml /path/to/your/file.nmrML
# this will produce a JSON dict of all extracted metadata

Or within a python program with the nmrml submodule:

from nmrml2isa import nmrml

nmrml_path = "/path/to/file.nmrML"
nmrml_meta = nmrml.nmrMLmeta(nmrml_path)

# python dictionnary
print(nmrml_meta.meta)

# json dictionnary
print(nmrml_meta.meta_json)

Download files

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

Source Distributions

nmrml2isa-0.2.0.zip (59.2 kB view details)

Uploaded Source

nmrml2isa-0.2.0.tar.gz (53.2 kB view details)

Uploaded Source

File details

Details for the file nmrml2isa-0.2.0.zip.

File metadata

  • Download URL: nmrml2isa-0.2.0.zip
  • Upload date:
  • Size: 59.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nmrml2isa-0.2.0.zip
Algorithm Hash digest
SHA256 9ac68cf6a7e9e67e6a4274b9ebdcb9bf25da7fa2f17c7027ecabdc1159cce3ae
MD5 9e32f760a210b91d9f176ebb28abf4ed
BLAKE2b-256 5262f3c354235e27c4a263f96556cbbba8a510252274d7857d017b69167bdc0a

See more details on using hashes here.

File details

Details for the file nmrml2isa-0.2.0.tar.gz.

File metadata

  • Download URL: nmrml2isa-0.2.0.tar.gz
  • Upload date:
  • Size: 53.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for nmrml2isa-0.2.0.tar.gz
Algorithm Hash digest
SHA256 50f78a4ddd2d65b96f889fdbed326158a253b277e19f1ab0e1782425fc1366d4
MD5 26681dc16d99468b95649dcd401e15bd
BLAKE2b-256 2069966110cde4e5d6db5b10a37a52bceeec950bd580f4f06b3f8af2f4fd91b3

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