Skip to main content

Version Py versions Git Build Status License RTD doc

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.1.3.tar.gz (52.7 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.3-py3-none-any.whl (56.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for nmrml2isa-0.1.3.tar.gz
Algorithm Hash digest
SHA256 eccf24ae03da74f94ea880a54c350fd0eb39b9e7f65445d5bbd8f3fc5533d7f9
MD5 3ca05e6bb4d867f98e4ad5614404b819
BLAKE2b-256 bd927c86a3f0ddb5c19907143a900d5efbc76eb8e6fb55a6280ef1cfc913aa1a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nmrml2isa-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3c2a58696bfac0762b07bc86de4201b5b6eec9021cabda395918d0eda7430017
MD5 fd0ea0fecd22da83d3889156df0de25b
BLAKE2b-256 06a13e22bc7b37d9bb9fb512ec6fd36c4a9fe959bb140569df5b40eefb800e97

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