diff --git a/README.md b/README.md index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..7c5da8ac0a1a46b4e760ada2102095effbf99be0 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,33 @@ +# Protocole du TP: + +## Description +Ce projet automatise l'exécution de quatre scripts R pour une analyse GWAS à l'aide d'un Makefile, garantissant ainsi un processus totalement automatisé. + +## Installation de micromamba +Les instructions d'installation de micromamba se trouvent dans le fichier `doc/01install.md`. + +## Utilisation des containers + +1.**Construire l'image Docker:** + -Accédez au dossier **containers** + -Exécutez la commande suivante dans le terminal : + docker build -t Dockerfile + +2.**Convertir l'image Docker en fichier SIF:** + -Assurez-vous que le fichier `m2bsgreprod.def` est dans le dossier **containers** + -Exécutez la commande suivante : + sudo apptainer build results/containers/m2bsgreprod3.sif results/containers/m2bsgreprod.def + +## Exécution +Les étapes pour exécuter l'analyse sont détaillées dans le fichier `doc/02run.md`. + +## Organisation des dossiers +**containers** : définitions de l'image virtuelle avec les versions spécifiques des logiciels et packages requis +**doc** : documentation d'installation et d'exécution +**src** : scripts R pour l'analyse GWAS +**workflows** : makefile pour exécuter les scripts dans l'ordre nécessaire +**.gitignore** : fichiers à exclure de la publication +**RELEASE.md** : historique des versions de git + +## Version +Pour obtenir des informations sur la version, veuillez consulter le commit et la branche indiqués dans le fichier `RELEASE.md`.