Skip to main content

Version Py versions Git Build Status License RTD doc DOI

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.2.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.2-py3-none-any.whl (57.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nmrml2isa-0.2.2.tar.gz
Algorithm Hash digest
SHA256 3dcb6f80e1c1da5829d14409b054c1a5e021ec916ab6144d924cbf5a2c64e0e9
MD5 83a601d961d54960f9fdabfa4b0ec687
BLAKE2b-256 6b86e89b91719e17bd1f9c13cdb82ea1ad144ffcefdddb60dc4c68f09e01b571

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nmrml2isa-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9bd8ad1b6f974e53856266afb7d3a270a4eea25d22b57ed5d5ba4cf3ad071170
MD5 f0ba89461cc6606509b67a6fb1e8d7fc
BLAKE2b-256 2d104e9a74fdc5cee47eabc3d06979e45109988d42f955ece73b415a93036019

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