Skip to main content

Version Py versions Git Build Status License RTD doc DOI

NMRML

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)

Release files for nmrml2isa 0.3.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nmrml2isa 0.3.3
File Size Uploaded
nmrml2isa-0.3.3.tar.gz 83.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nmrml2isa 0.3.3
File Interpreter ABI Platform
nmrml2isa-0.3.3-py3-none-any.whl Python 3 none any Details

Total release size: 171.2 kB

Release files / nmrml2isa-0.3.3.tar.gz

Download URL nmrml2isa-0.3.3.tar.gz
Size 83.7 kB
Tags Source
SHA-256 checksum
How to use checksums
87269827b36b7df01f8909e4148c67ad585d8441432135fe41bf8abf4c41e99f
BLAKE2b-256 checksum
How to use checksums
c3fbc5a9965e80310c086286ef0b94df8c90a55ac5c35b9dde67aadcedefd8bc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.6

Release files / nmrml2isa-0.3.3-py3-none-any.whl

Download URL nmrml2isa-0.3.3-py3-none-any.whl
Size 87.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2d0e8f7f233ffe2d7b2e4444ae6caa9a37b40c689af94b9b97228b862766a0a9
BLAKE2b-256 checksum
How to use checksums
5a2debb401671cca8f2ca22fe58c29f6aabe95ad88ed1c165f8a40a292d89f4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/4.0.2 CPython/3.11.6

Release history Release notifications | RSS feed

This release

0.3.3 This release

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.3

4 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

3 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page