# NutriCheck
## Description
**NutriCheck** est un pipeline conçu pour évaluer la comestibilité d'une bactérie à partir de son génome annoté. Il s'appuie sur des analyses de toxicité potentielle, de valeur nutritionnelle et de digestibilité. Le pipeline compare les résultats obtenus à un ensemble de données d'entraînement comprenant :
- 11 témoins positifs (bactéries présentes dans notre alimentation).
- 9 témoins négatifs (bactéries pathogènes).
Le pipeline utilise **Snakemake** et nécessite en entrée une séquence d'ADN au format FASTA.
---
## Fonctionnement
### Étapes principales
1. **Annotation génomique avec PGAP**
- L'utilisateur fournit une séquence d'ADN au format FASTA et le nom de l'organisme.
- Le pipeline génère une annotation génomique complète via le **NCBI Prokaryotic Genome Annotation Pipeline (PGAP)**.
- Le fichier résultant, `annot_cds_from_genomic.fna`, contient les régions codantes annotées nécessaires pour les analyses suivantes.
2. **Analyse de la toxicité avec GeNomad**
- Le script traite le fichier FASTA annoté pour en simplifier les en-têtes et générer un fichier FASTA formaté.
- **GeNomad** est ensuite exécuté pour détecter les éléments génétiques mobiles (plasmides, virus).
- Résultats principaux :
- Si des éléments génétiques mobiles sont détectés, l'organisme est considéré comme potentiellement non comestible.
- Si aucun élément mobile n'est détecté, l'organisme est potentiellement comestible.
3. **Recherche de gènes de résistance avec AMRFinder**
- **AMRFinder** identifie les gènes de résistance aux antibiotiques.
- Les résultats sont enregistrés dans `output_amrfinder.txt` et interprétés pour déterminer la présence de gènes toxiques.
4. **Analyse phagique avec VirSorter**
- **VirSorter** analyse le fichier FASTA pour identifier des séquences phagiques ou des prophages potentiellement présents.
- La présence de phages indique que la bactérie n'est pas comestible, ce qui constitue un critère crucial dans l'évaluation de la sécurité alimentaire.
5. **Analyse de la nutritivité par calcul du CAI**
-
6. **Analyse de la digestibilité par calcul du taux de GC**
-
---
## Utilisation
### Prérequis
Installez **Snakemake** via la documentation : https://snakemake.readthedocs.io/en/stable/getting_started/installation.html
### Commandes
1. **Lancer le pipeline**
Positionnez-vous dans le répertoire contenant le fichier `Snakefile` et exécutez :
```bash
snakemake
```
2. **Entrées nécessaires**
- Un fichier FASTA contenant la séquence d'ADN.
- Le nom de l'organisme associé à la séquence.
3. **Résultats principaux**
Les résultats finaux incluent :
- Un tableau synthétisant les informations obtenues pour chaque génome analysé. Ce tableau inclut les colonnes suivantes :
ID : Identifiant du génome analysé.
Nombre de plasmides : Nombre de plasmides détectés dans le génome.
Nombre de virus : Nombre de virus/phages identifiés.
AMR : Indication de la présence ou absence de gènes de résistance aux antibiotiques (Antimicrobial Resistance, AMR).
Taux purine : Proportion des bases purines (A et G) dans le génome.
Distance par rapport à l'oeuf : Une métrique de distance calculée par rapport à un génome de référence spécifique, celui de l'œuf.
- Évaluation de la comestibilité.
- Sorties détaillées des outils (fichiers d'analyse et rapports).
---
## Auteurs
- Développé par : Thomas GAGNIEU, Mathieu GUIGARD, Thibaud GUIRAMAND, Kessen POITOU
- Contact : thomas.gagnieu@etu.univ-lyon1.fr, mathieu.guigard@etu.univ-lyon1.fr, thibaud.guiramand@etu.univ-lyon1.fr, kessen.poitou@etu.univ-lyon1.fr
Raw data
{
"_id": null,
"home_page": null,
"name": "NutriCheck",
"maintainer": "Kessen Poitou",
"docs_url": null,
"requires_python": null,
"maintainer_email": "Thomas Gagnieu <thomas.gagnieu@etu.univ-lyon1.fr>, Mathieu Guigard <mathieu.guigard@etu.univ-lyon1.fr>, Thibaud Guiramand <thibaud.guiramand@etu.univ-lyon1.fr>",
"keywords": "annotation, comestibility, digestibility, gene, gene expression, toxicity",
"author": "Kessen Poitou",
"author_email": "Thomas Gagnieu <thomas.gagnieu@etu.univ-lyon1.fr>, Mathieu Guigard <mathieu.guigard@etu.univ-lyon1.fr>, Thibaud Guiramand <thibaud.guiramand@etu.univ-lyon1.fr>",
"download_url": "https://files.pythonhosted.org/packages/7f/a8/a1b79e73fc0aff351e1f82d0ea3d6fe50f48e195ac4a68256fcb7e72e0b2/nutricheck-0.1.5.tar.gz",
"platform": null,
"description": "# NutriCheck\n\n## Description\n\n**NutriCheck** est un pipeline con\u00e7u pour \u00e9valuer la comestibilit\u00e9 d'une bact\u00e9rie \u00e0 partir de son g\u00e9nome annot\u00e9. Il s'appuie sur des analyses de toxicit\u00e9 potentielle, de valeur nutritionnelle et de digestibilit\u00e9. Le pipeline compare les r\u00e9sultats obtenus \u00e0 un ensemble de donn\u00e9es d'entra\u00eenement comprenant :\n- 11 t\u00e9moins positifs (bact\u00e9ries pr\u00e9sentes dans notre alimentation).\n- 9 t\u00e9moins n\u00e9gatifs (bact\u00e9ries pathog\u00e8nes).\n\nLe pipeline utilise **Snakemake** et n\u00e9cessite en entr\u00e9e une s\u00e9quence d'ADN au format FASTA.\n\n---\n\n## Fonctionnement\n\n### \u00c9tapes principales\n\n1. **Annotation g\u00e9nomique avec PGAP**\n - L'utilisateur fournit une s\u00e9quence d'ADN au format FASTA et le nom de l'organisme.\n - Le pipeline g\u00e9n\u00e8re une annotation g\u00e9nomique compl\u00e8te via le **NCBI Prokaryotic Genome Annotation Pipeline (PGAP)**.\n - Le fichier r\u00e9sultant, `annot_cds_from_genomic.fna`, contient les r\u00e9gions codantes annot\u00e9es n\u00e9cessaires pour les analyses suivantes.\n\n2. **Analyse de la toxicit\u00e9 avec GeNomad**\n - Le script traite le fichier FASTA annot\u00e9 pour en simplifier les en-t\u00eates et g\u00e9n\u00e9rer un fichier FASTA format\u00e9.\n - **GeNomad** est ensuite ex\u00e9cut\u00e9 pour d\u00e9tecter les \u00e9l\u00e9ments g\u00e9n\u00e9tiques mobiles (plasmides, virus).\n - R\u00e9sultats principaux :\n - Si des \u00e9l\u00e9ments g\u00e9n\u00e9tiques mobiles sont d\u00e9tect\u00e9s, l'organisme est consid\u00e9r\u00e9 comme potentiellement non comestible.\n - Si aucun \u00e9l\u00e9ment mobile n'est d\u00e9tect\u00e9, l'organisme est potentiellement comestible.\n\n3. **Recherche de g\u00e8nes de r\u00e9sistance avec AMRFinder**\n - **AMRFinder** identifie les g\u00e8nes de r\u00e9sistance aux antibiotiques.\n - Les r\u00e9sultats sont enregistr\u00e9s dans `output_amrfinder.txt` et interpr\u00e9t\u00e9s pour d\u00e9terminer la pr\u00e9sence de g\u00e8nes toxiques.\n\n4. **Analyse phagique avec VirSorter**\n - **VirSorter** analyse le fichier FASTA pour identifier des s\u00e9quences phagiques ou des prophages potentiellement pr\u00e9sents.\n - La pr\u00e9sence de phages indique que la bact\u00e9rie n'est pas comestible, ce qui constitue un crit\u00e8re crucial dans l'\u00e9valuation de la s\u00e9curit\u00e9 alimentaire. \n\n5. **Analyse de la nutritivit\u00e9 par calcul du CAI**\n - \n\n6. **Analyse de la digestibilit\u00e9 par calcul du taux de GC**\n - \n\n---\n\n## Utilisation\n\n### Pr\u00e9requis\n\nInstallez **Snakemake** via la documentation : https://snakemake.readthedocs.io/en/stable/getting_started/installation.html\n\n### Commandes\n\n1. **Lancer le pipeline**\n Positionnez-vous dans le r\u00e9pertoire contenant le fichier `Snakefile` et ex\u00e9cutez :\n ```bash\n snakemake\n ```\n\n2. **Entr\u00e9es n\u00e9cessaires**\n - Un fichier FASTA contenant la s\u00e9quence d'ADN.\n - Le nom de l'organisme associ\u00e9 \u00e0 la s\u00e9quence.\n\n3. **R\u00e9sultats principaux**\n Les r\u00e9sultats finaux incluent :\n\n - Un tableau synth\u00e9tisant les informations obtenues pour chaque g\u00e9nome analys\u00e9. Ce tableau inclut les colonnes suivantes :\n\nID : Identifiant du g\u00e9nome analys\u00e9.\n\nNombre de plasmides : Nombre de plasmides d\u00e9tect\u00e9s dans le g\u00e9nome.\n\nNombre de virus : Nombre de virus/phages identifi\u00e9s.\n\nAMR : Indication de la pr\u00e9sence ou absence de g\u00e8nes de r\u00e9sistance aux antibiotiques (Antimicrobial Resistance, AMR).\n\nTaux purine : Proportion des bases purines (A et G) dans le g\u00e9nome.\n\nDistance par rapport \u00e0 l'oeuf : Une m\u00e9trique de distance calcul\u00e9e par rapport \u00e0 un g\u00e9nome de r\u00e9f\u00e9rence sp\u00e9cifique, celui de l'\u0153uf.\n\n - \u00c9valuation de la comestibilit\u00e9.\n - Sorties d\u00e9taill\u00e9es des outils (fichiers d'analyse et rapports).\n\n\n---\n\n## Auteurs\n\n- D\u00e9velopp\u00e9 par : Thomas GAGNIEU, Mathieu GUIGARD, Thibaud GUIRAMAND, Kessen POITOU\n- Contact : thomas.gagnieu@etu.univ-lyon1.fr, mathieu.guigard@etu.univ-lyon1.fr, thibaud.guiramand@etu.univ-lyon1.fr, kessen.poitou@etu.univ-lyon1.fr",
"bugtrack_url": null,
"license": null,
"summary": "Prediction of the comestibility of a micro-organism from its DNA sequence",
"version": "0.1.5",
"project_urls": {
"repo_git": "http://pedago-service.univ-lyon1.fr:2325/mguigard/sujet-9/-/tree/package?ref_type=heads"
},
"split_keywords": [
"annotation",
" comestibility",
" digestibility",
" gene",
" gene expression",
" toxicity"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "e8465a2583e8c317241d391be666f529535d44e65f14b688adf256f19ede0b68",
"md5": "35ac29a55bb0331dc66fb2bbc26739f5",
"sha256": "0d5e2b912a5f4940e51a5cb09f2a14f68c9d5cf759e769e0a43404ef8491dcf3"
},
"downloads": -1,
"filename": "nutricheck-0.1.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "35ac29a55bb0331dc66fb2bbc26739f5",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 15003,
"upload_time": "2024-12-17T09:37:03",
"upload_time_iso_8601": "2024-12-17T09:37:03.412472Z",
"url": "https://files.pythonhosted.org/packages/e8/46/5a2583e8c317241d391be666f529535d44e65f14b688adf256f19ede0b68/nutricheck-0.1.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7fa8a1b79e73fc0aff351e1f82d0ea3d6fe50f48e195ac4a68256fcb7e72e0b2",
"md5": "2f4858c237aec9072b79d3823ff09031",
"sha256": "5bc217037a201433998ab74acd1fd9eab20fab9b9a28c9ed270898af242fe2c5"
},
"downloads": -1,
"filename": "nutricheck-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "2f4858c237aec9072b79d3823ff09031",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 99271,
"upload_time": "2024-12-17T09:37:05",
"upload_time_iso_8601": "2024-12-17T09:37:05.575305Z",
"url": "https://files.pythonhosted.org/packages/7f/a8/a1b79e73fc0aff351e1f82d0ea3d6fe50f48e195ac4a68256fcb7e72e0b2/nutricheck-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-17 09:37:05",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "nutricheck"
}