Skip to main content

A tool for Differential analysis of Isotope-labeled targeted Metabolomics data

Project description

DIMet: Differential analysis of Isotope-labeled targeted Metabolomics data

logo

Introduction

DIMet is a bioinformatics pipeline for differential and time-course analysis of targeted isotope-labeled metabolomics data.

DIMet supports the analysis of full metabolite abundances and isotopologue contributions, and allows to perform it either in the differential comparison mode or as a time-series analysis. As input, DIMet accepts three types of measures: a) isotopologues’ contributions, b) fractional contributions (also known as mean enrichment), c) full metabolites’ abundances. DIMet also offers a pathway-based omics integration through Metabolograms.

Note: DIMet is intended for downstream analysis of tracer metabolomics data that has been corrected for the presence of natural isotopologues.

Formatting and normalisation helper: scripts for formatting and normalization are provided in TraceGroomer.

New: DIMet is now available in Galaxy: Visit https://usegalaxy.eu/ to access the user-friendly interface of our tool.


Installing DIMet

System Requirements

DIMet installation requires an Unix environment with python 3.9. It was tested under Linux and MacOS environments.

Installation

The full installation process should take less than 15 minutes on a standard computer.

Via pip command: pip install dimet

Or if you are a developer working in a local cloned version, you can install: pip install -e .

Alternatively to the PyPI version, our tool is also available as a conda package. Moreover, it can be used via Docker (docker pull quay.io/biocontainers/dimet:0.1.4) or singularity (depot.galaxyproject.org/singularity/dimet:0.1.4--pyhdfd78af_0) containers.

Code organization

  • src/dimet/processing directory contains the implemented high-level analysis scripts that produced the tables for the DIMet paper
  • src/dimet/visualization : directory contains the implemented high-level scripts that produced the figures in the DIMet paper
  • src/dimet/data directory contains the python classes for data initialization
  • src/dimet/method directory contains the python classes for configuration handling
  • tests directory contains unit tests
  • tools directory contains venv setup scripts.

Running unit tests

  • With pytest, by running pytest from DIMet
  • Alternatively, place yourself in DIMet/tests and execute python -m unittest

Documentation

All the details about how to run DIMet can be found on the dedicated Wiki page. Importantly, this is where you will find the information about how to organise the data (folder structure) and how to populate the configuration files to successfully run DIMet.


Getting help

For any information or help running DIMet, you can get in touch with:

LICENSE MIT

Copyright (c) 2023 

Johanna Galvis (1,2)    deisy-johanna.galvis-rodriguez@u-bordeaux.fr
Benjamin Dartigues (2)	benjamin.dartigues@u-bordeaux.fr
Florian Specque (1,2)   florian.specque@u-bordeaux.fr
Slim Karkar (1,2)       slim.karkar@u-bordeaux.fr
Helge Hecht (3,5)       helge.hecht@recetox.muni.cz
Bjorn Gruening (4,5)    bjoern.gruening@gmail.com
Hayssam Soueidan (2)    massyah@gmail.com
Macha Nikolski (1,2)    macha.nikolski@u-bordeaux.fr

(1) CNRS, IBGC - University of Bordeaux,
1, rue Camille Saint-Saens, Bordeaux, France

(2) CBiB - University of Bordeaux,
146, rue Leo Saignat, Bordeaux, France

(3) Spectrometric Data Processing and Analysis,
Masaryk University, Brno, Czech Republic

(4) University of Freiburg, 
Freiburg, Germany

(5) Galaxy Europe

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dimet-0.2.0.tar.gz (53.3 kB view details)

Uploaded Source

Built Distribution

dimet-0.2.0-py3-none-any.whl (66.0 kB view details)

Uploaded Python 3

File details

Details for the file dimet-0.2.0.tar.gz.

File metadata

  • Download URL: dimet-0.2.0.tar.gz
  • Upload date:
  • Size: 53.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for dimet-0.2.0.tar.gz
Algorithm Hash digest
SHA256 40d5dee29232deb5722392c745a70f757c78128829b372ce0093fe2fbaf9411e
MD5 b9b019f679c389e68c8e29c0fed7b214
BLAKE2b-256 8bad9fc55a03a20751f895a4243e974ae9f4686d51fb76c90d07197b121b090c

See more details on using hashes here.

Provenance

File details

Details for the file dimet-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: dimet-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 66.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for dimet-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a5e5f3d920a395ae90c827a7dd837d59f76f4d561cd1350a4b48f4c8a5fe431f
MD5 6774fa94e042d3a2b459646f49b2668b
BLAKE2b-256 9f8a768ea2146a129f05d14982d263ab91dab5e10fd3b2dc136d17a911033a4f

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page