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 Distribution

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

Uploaded Source

Built Distribution

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

nmrml2isa-0.2.1-py3-none-any.whl (57.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nmrml2isa-0.2.1.tar.gz
Algorithm Hash digest
SHA256 5f48b1286481a3833bf121842a6aa6a3585865aa0b066ec96dc6bd2400a14220
MD5 68af7b755f049e2197fd8c58e46d38ad
BLAKE2b-256 6604bb262c65c7810d52af6cd261b1bbb6db3b34eceb3656bee7db956f2c9240

See more details on using hashes here.

File details

Details for the file nmrml2isa-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for nmrml2isa-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5643c3e6b2317519ec2f223add06539f4ac14cad702bf58961c0115a78f12f4a
MD5 bdf4e9ac997402ef365528a0d5e3bd4a
BLAKE2b-256 5ef2e6ac5280058a54acd1f960ec6f4c2f187bf6c8a61d202964b4e12106a7e5

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