Giter VIP home page Giter VIP logo

isocor's Introduction

IsoCor - Isotope Correction for mass spectrometry labeling experiments

PyPI version PyPI pyversions Build Status Documentation Status

IsoCor graphical user interface

What is IsoCor?

IsoCor is a scientific software dedicated to the correction of mass spectrometry (MS) data for naturally occuring isotopes. IsoCor corrects raw MS data (mass fractions) for naturally-occurring isotopes of all elements and purity of the isotopic tracer. The output of IsoCor is the isotopologue distribution of the molecule (i.e. the relative fractions of molecular entities differing only in the number of isotopic substitutions of the tracer). IsoCor also calculates the mean enrichment (i.e. the mean isotopic content in the molecule) in metabolites.

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

The code is open-source, and available under a GPLv3 license. Additional information can be found in IsoCor publication.

Detailed documentation can be found online at Read the Docs (https://isocor.readthedocs.io/). Check out the Tutorials to use the best correction option!

Key features

  • correction of naturally occuring isotopes, both for non-tracer and tracer elements,
  • correction of tracer purity,
  • shipped as a library with both a graphical and command line interface,
  • mass-spectrometer and resolution agnostic,
  • can be applied to singly- and multiply-charged ions
  • can be used with any tracer element (having two or more isotopes)
  • account for the contribution of derivatization steps (if any),
  • generate isotopic InChIs of the tracer isotopologues,
  • open-source, free and easy to install everywhere where Python 3 and pip run,
  • biologist-friendly.

Quick-start

IsoCor requires Python 3.5 or higher and run on all plate-forms. Please check the documentation for complete installation and usage instructions.

Use pip to install IsoCor from PyPi:

$ pip install isocor

Then, start the graphical interface with:

$ isocor

IsoCor is also available directly from command-line and as a Python library.

Bug and feature requests

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

Developers guide

Contributions

Contributions are very welcome! ❤️

Please work on your own fork, follow PEP8 style guide, and make sure you pass all the tests before a pull request.

Local install with pip

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

Unit tests

Isotope correction is a complex task and we use unit tests to make sure that critical features are not compromised during development.

You can run all tests by calling pytest in the shell at project's root directory.

Build the documentation locally

Build the HTML documentation with:

$ cd doc
$ make html

The PDF documentation can be built locally by replacing html by latexpdf in the command above. You will need a recent latex installation.

How to cite

Millard P., Delépine B., Guionnet M., Heuillet M., Bellvert F. and Letisse F. IsoCor: isotope correction for high-resolution MS labeling experiments. Bioinformatics, 2019, doi: 10.1093/bioinformatics/btz209

Authors

Baudoin Delépine, Matthieu Guionnet, Pierre Millard

Contact

📧 Pierre Millard, [email protected]

isocor's People

Contributors

bdelepine avatar pierremillard avatar gmat 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.