https://github.com/cbib/tracegroomer

Format and normalise tracer metabolomics given file(s), to produce the .csv files which are ready for DIMet analysis.

https://github.com/cbib/tracegroomer

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
  • DOI references
    Found 4 DOI reference(s) in README
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.3%) to scientific vocabulary
Last synced: 9 months ago · JSON representation

Repository

Format and normalise tracer metabolomics given file(s), to produce the .csv files which are ready for DIMet analysis.

Basic Info
  • Host: GitHub
  • Owner: cbib
  • License: mit
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 347 KB
Statistics
  • Stars: 1
  • Watchers: 2
  • Forks: 1
  • Open Issues: 0
  • Releases: 5
Created over 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme License

README.md

TraceGroomer

PyPI - Python Version bioconda package

TraceGroomer is a solution for formatting and normalising isotope-labeled (a.k.a Tracer) Metabolomics given file(s), to produce the tabular files which are ready for DIMet tool.

Not only one, but several input formats are accepted by TraceGroomer!: these input formats are described in detail (visit the Wiki link provided in our documentation section), e.g. IsoCor output files are currently supported.

TraceGroomer processes your data in seconds!

For any type of the supported inputs, TraceGroomer generates an independent file for each type of quantification: i) total metabolite abundances ii) Isotopologues iii) Isotopologues' proportions and iv) mean enrichment (a.k.a fractional contributions).

Advantages of using TraceGroomer for preparing your data for DIMet:

  • if only Isotopologues' absolute values are provided, TraceGroomer generates all the other quantifications automatically.
  • fast, automatic formatting is performed, as well as the normalization chosen by the user: whether by the amount of material and/or by an internal standard.
  • useful advanced options are offered (e.g. different modalities of normalization by the amount of material).

Note : TraceGroomer does not correct for naturally occurring isotopologues. Your data must be already processed by another software that performs such correction (e.g. IsoCor).

[!IMPORTANT] When using TraceGroomer, please cite:

Galvis J, Guyon J, Dartigues B, Hecht H, Grüning B, Specque F, Soueidan H, Karkar S, Daubon T, Nikolski M. DIMet: An open-source tool for Differential analysis of targeted Isotope-labeled Metabolomics data. Bioinformatics 2024; 40(5) btae282. https://doi.org/10.1093/bioinformatics/btae282


Requirements

TraceGroomer requires Python 3.10+. Running in a virtual environment is highly recommended.

Install it via pip: pip install tracegroomer

Tracegroomer is also available as a conda package

Alternatively, if you are a developer, you can do a local install:

Local install of TraceGroomer (click to show/hide) For a local install, clone this repository, make sure you have activated your virtual environment with Python 3.10+ (source MYVIRTUALENV/bin/activate), with poetry installed.

Then install dependencies: locate yourself in TraceGroomer and run poetry install

After this, the tool is ready to use: python -m tracegroomer --help

Documentation

All the details about how to use TraceGroomer can be found on the dedicated Wiki page. This is where you will find the information of the supported formats, examples, and how to run TraceGroomer.

Getting help

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


LICENSE MIT

Copyright (c) 2024

Johanna Galvis (1,2)    deisy-johanna.galvis-rodriguez@u-bordeaux.fr
Benjamin Dartigues (2)  benjamin.dartigues@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
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) RECETOX
Faculty of Science, Masaryk University, Kotlářksá 2, 611 37 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.

Owner

  • Name: Centre de Bioinformatique de Bordeaux
  • Login: cbib
  • Kind: organization
  • Location: Université de Bordeaux (146, rue Léo Saignat 33076 Bordeaux cedex)

GitHub Events

Total
Last Year

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 5
  • Total pull requests: 13
  • Average time to close issues: 13 days
  • Average time to close pull requests: about 16 hours
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 1.2
  • Average comments per pull request: 0.31
  • Merged pull requests: 12
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • johaGL (4)
  • hechth (1)
Pull Request Authors
  • johaGL (9)
  • hechth (4)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 10 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
pypi.org: tracegroomer

Convert and normalise metabolomics data formats (preprocessing for DIMet)

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 10 Last month
Rankings
Dependent packages count: 9.8%
Average: 37.4%
Dependent repos count: 65.0%
Maintainers (1)
Last synced: 10 months ago