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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nmrml2isa-0.3.0.tar.gz
Algorithm Hash digest
SHA256 021dd4df93b20e895a5ab465e2cd4b8f92b1359c110339bb6bae4b96549b9802
MD5 3f56e532da5ab8d7ee62bd32c1d21253
BLAKE2b-256 6187eb7ed3b5dfcdaa5109355daf7ccab722ce984cf49283bead437d6a51cd8a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nmrml2isa-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d0f17b2cfd8b697d42ecbe75fa194b2a389226e6eba187ce602c303ba159ba19
MD5 22a94824bea81d1890913a28bdeee1e7
BLAKE2b-256 f978883ba755b9d1617aba41973ee23a59a367a65568e26d4c0fcffceaf6f554

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 Pingdom Monitoring Sentry Error logging StatusPage Status page