Giter Club home page Giter Club logo

isoq's Introduction

IsoQ - Simultaneous measurement of metabolite concentration and isotope incorporation by MS

What is IsoQ?

IsoQ is a scientific software dedicated to the automated processing of metabolomics and isotopic MS measurements. IsoQ corrects raw MS data (mass fractions) for naturally-occurring isotopes of all elements and purity of the isotopic tracer using IsoCor, and calculates metabolite concentrations from calibration curves.

It is one of the routine tools that we use at the MetaSys team and MetaToul platform in isotopic studies of metabolic systems.

Additional information can be found in the following publication:

Simultaneous measurement of absolute metabolite concentration and isotope incorporation by mass spectrometry, by Maud Heuillet, Pierre Millard, Madi Cissé, Matthieu Guionnet, Laetitia Linares, Fabien Létisse, Laurent Le Cam, Jean-Charles Portais and Floriant Bellvert.

The code is open-source, and available under a GPLv3 license.

Installation

IsoQ requires Python 3.5 or higher and run on all plate-forms. If you do not have a Python environment configured on your computer, we recommend that you follow the instructions from Anaconda.

To install IsoQ locally, open a terminal (e.g. run Anaconda Prompt if you have installed Anaconda) and type:

$ pip install git+https://github.com/MetaSys-LISBP/IsoQ.git

Alternatively, you can download the github repository and run:

$ pip install /path/to/IsoQ/

Usage

An example of IsoQ usage is provided here and in */isoq/data/* with the associated data files.

First, load IsoQ in your Python session (IsoQ must be installed beforehand, as detailed above):

> import isoq.process as iq

The processing of a dataset starts by defining some information relative to the dataset (e.g. data directory) as well as the processing parameters:

Data files

> datafile = "example_dataset.csv"
> calibfile = "example_calibration.csv"
> data_folder = "C:/Users/millard/Documents/GIT/IsoQ/IsoQ/isoq/data/"

Processing parameters

> # isotopic tracer
> tracer = '13C'
> # resolution of the MS instrument, m/z at which resolution is measured, and type of instrument (see IsoCor documentation for details)
> resolution = 70000
> mz_of_resolution = 400
> resolution_formula_code = 'orbitrap'
> # options relative to the purity of the isotopic tracer (see IsoCor documentation for details)
> tracer_purity = [0.01, 0.99]
> correct_NA_tracer = True
> # isotopic purity of the other isotope used in the IS
> purity15N = [0.01, 0.99]

Then, process your data by running the following command:

> iq.run(data_folder, # data directory (str)
>        datafile, # name of the file containing the samples data (str)
>        calibfile, # name of the file containing the calibration data (str)
>        tracer, # isotopic tracer (str)
>        resolution, # resolution of the MS spectrometer (float)
>        mz_of_resolution, # m/z at which the resolution is given (float)
>        tracer_purity, # isotopic purity of the tracer (vector)
>        correct_NA_tracer, # correct (or not) for natural abundance of the tracer element (boolean)
>        resolution_formula_code, # formula to calculate resolution on the MS instrument (str)
>        purity15N=purity15N, # 15N purity of the 13C15N-IS (vector)
>        verbose=False # verbose output (boolean)
>        )

The following information are saved in the data directory:

  • results.pdf: contains the calibration results (calibration curves, R², relative residuals, etc)
  • results_CID.csv: contains the isotopic data (carbon isotopologue distributions, mean enrichment, residuum, etc) as detailed in IsoCor documentation
  • results_conc.csv: contains the calculated metabolite concentrations
  • results.log: contains detailed information about the processing (correction parameters, warnings and errors that may occur during processing, etc)

Bug and feature requests

If you have an idea on how we could improve IsoQ please submit a new issue to our GitHub issue tracker.

Contributions

Contributions are very welcome! ❤️

In development mode, do a pip install -e /path/to/IsoQ/ to install locally the development version.

Please work on your own fork and follow PEP8 style guide.

How to cite

Heuillet M., Millard P., Cissé M., Guionnet M., Linares L., Létisse F., Le Cam L., Portais J.-C. and Bellvert F. Simultaneous measurement of absolute metabolite concentration and isotope incorporation by mass spectrometry. Submitted.

Authors

Pierre Millard, Baudoin Delépine

Contact

📧 Pierre Millard, [email protected]

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.