Code Monkey home page Code Monkey logo

bfg-test's Introduction

mzml2isa

Parser to extract meta information from mzML mass spectrometry files and parse relevant information to a ISA-Tab structure

Version Py versions Git Bioconda Build Status (Travis) Build Status (AppVeyor) License RTD doc DOI

Overview

mzml2isa is a Python3 program that can automatically generate ISA-Tab document structure metadata files from raw XML metabolomics data files (mzML open access data format). The mzml2ISA tool provides the backbone of ISA-Tab metabolomics study which can then be edited with an ISA editing tool, ISAcreator (see MetaboLights pre-packaged ISA Creator)

Currently the program does the following:
  • Extract meta information from mzML files and stores it as either python dictionary or JSON format
  • Creates an ISA-Tab file structure with relevant meta information filled in.
  • Add additional metadata that cannot be parsed from mzML files to the ISA-Tab files through a JSON formatted dictionnary.

Install

See the Installation page of the online documentation.

Usage

CLI

mzml2isa -i /path/to/mzml_files/ -o /path/to/out_folder/ -s name_of_study

Python Module

See the Usage page and the Examples page for more information.

Metabolights

To download some real data from MetaboLights studies to test the converter with, run

python scripts/metabolights-dl.py <size>

from inside the repository, where size is the maximum size in GiB you can allocate to download files. The script will download the files to the example_files/metabolights folder and then run mzml2isa on those files..

If you use a *NIX machine with curlftpfs and bash available, you can also run

scripts/metabolights.sh

to mount the database to the example directory and start converting mzML studies.

Workflow

workflow

bfg-test's People

Contributors

althonos avatar djcomlab avatar rjmw avatar rsalek avatar tomnl avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.