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.1.tar.gz (69.3 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.1-py3-none-any.whl (77.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nmrml2isa-0.3.1.tar.gz
Algorithm Hash digest
SHA256 5bae79e717eaed9a0147324adae7dcb54d435f80683e7a1b2cec032a2803f97c
MD5 b176a179e6d4202a8a40f3199ba7764e
BLAKE2b-256 e16000ce1a1c586e52ebbd7b58d1652ca2ecd36131bdd766de34a6a017fca693

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nmrml2isa-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5fe5eb59270b421bd6788af18bb836b3a6f879e70f2d41dae4b8396921a3e9c8
MD5 d008bbd1df8351f4645a57d051cc2acf
BLAKE2b-256 c618eb583f430bdd3f6d7724f8ceec9db9248c1984ca6029b13276918baec641

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