Skip to main content

Version Py versions Git Build Status License

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

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.1.0.tar.gz (52.1 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.1.0-py3-none-any.whl (56.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nmrml2isa-0.1.0.tar.gz
Algorithm Hash digest
SHA256 7ff51aa5dff307c170c14dfa099e80f5e8d3eef6fe3b94bbbeb271e05c32cfc6
MD5 e632afa958e9c4e2b104a56cea90b828
BLAKE2b-256 90e15b0b4dcd50817a7d415ab3fa9b09900683f32a4e5567af5937baa406a6c8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nmrml2isa-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9c875b9aca99da8babbcd4bad306bed2673b6366fdf84764dd2864c0a079e43d
MD5 713375527a6ab7305e689519df057de3
BLAKE2b-256 dd451aaa49d0f34abd7f837a6d7c7ee2c854a6b6ff58f975c280f952823378db

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