diff --git a/documentations/en/pages/configurations.md b/documentations/en/pages/configurations.md index d3a699da2260095e07636678a5f182c413d14a34..5ef5be4fe3731ffeb4881b8b29c9ffd638ab7c7a 100644 --- a/documentations/en/pages/configurations.md +++ b/documentations/en/pages/configurations.md @@ -1,7 +1,7 @@ # **Configuration** !!! tip - You can edit default settings in **config.yaml** file into **./config/** directory. + You can edit default settings in **config.yaml** file into **./config/** directory. ## **Resources** @@ -97,4 +97,4 @@ Edit to match your hardware configuration - **yaml***: conda environments paths/names/version (default: workflow/environments/{tools}\_v.{version}.yaml) !!! note - Edit only if you want to change some environments (e.g. test a new version or back to an older version) + Edit only if you want to change some environments (e.g. test a new version or back to an older version) diff --git a/documentations/en/pages/installations.md b/documentations/en/pages/installations.md index 4cb79b424eb23ce1547972afc050180780b6ffdb..9fb29977bcaaec4e2d256509ae041181e9f5db37 100644 --- a/documentations/en/pages/installations.md +++ b/documentations/en/pages/installations.md @@ -73,6 +73,9 @@ You can **download** GeVarLi as zip file from the git repository: [IRD-Forge / G # Rename mv ~/GeVarLi-main/ ~/GeVarLi/ + + # Move + cd ~/GeVarLi/ ``` !!! tip @@ -84,6 +87,6 @@ You can **download** GeVarLi as zip file from the git repository: [IRD-Forge / G git clone --depth 1 https://forge.ird.fr/transvihmi/nfernandez/GeVarLi.git ~/GeVarLi/ cd ~/GeVarLi/ - # Update/Pull (given you are into GeVarLi/ repository) + # Update using 'git pull' (given you are into GeVarLi/ repository) git reset --hard HEAD && git pull --depth 1 --verbose ``` diff --git a/documentations/en/pages/usage.md b/documentations/en/pages/usage.md index 4aa946d28995d8564bbcf678edc02e30ca515566..27eefcc52ed8e183eaf9241836cf90908c006da1 100644 --- a/documentations/en/pages/usage.md +++ b/documentations/en/pages/usage.md @@ -14,10 +14,11 @@ To start your first analysis: - or with a **Right-click** > **Open with** > **Terminal.app** - or with **CLI** from a terminal: -Exemple script: -```shell -./Run_GeVarLi.sh -``` +!!! shell + _Exemple script to rin GeVarLi_ + ```shell + ./Run_GeVarLi.sh + ``` !!! warning If your reads were generated with an **amplicon protocol**, you will also need to provide the **amplicon primer coordinates** in **BEDPE** format, so the **primers are trimmed appropriately** using **bamclipper**. @@ -133,8 +134,9 @@ Exemple script: │ └── 📦 SARS-CoV-2_Omicron-BA1_Covid-Seq-Lib-on-MiSeq_250000-reads_R2.fastq.gz │ └── 📂 documentation/ - ├── mkdocs.yaml - ├── extra.css + │ + ├── âš™ï¸ mkdocs.yaml + ├── 🌠extra.css │ ├── 📂 images/ │ │ @@ -146,13 +148,35 @@ Exemple script: │ ├── 📂 en/ │ │ - │ ├── index.md + │ ├── 📚 index.md │ │ │ └── 📂 pages/ + │ │ + │ ├── 📚 acknowledgedments.md + │ ├── 📚 afroscreen + │ ├── 📚 configurations.md + │ ├── 📚 contributions.md + │ ├── 📚 features.md + │ ├── 📚 glossary.md + │ ├── 📚 installations.md + │ ├── 📚 references.md + │ ├── 📚 results.md + │ └── 📚 usage.md │ └── 📂 fr/ │ - ├── index.md + ├── 📚 index.md │ - └── pages/ + └── 📂 pages/ + │ + ├── 📚 acknowledgedments.md + ├── 📚 afroscreen + ├── 📚 configurations.md + ├── 📚 contributions.md + ├── 📚 features.md + ├── 📚 glossary.md + ├── 📚 installations.md + ├── 📚 references.md + ├── 📚 results.md + └── 📚 usage.md ``` diff --git a/documentations/fr/pages/configurations.md b/documentations/fr/pages/configurations.md index bcefee6e65742c613b8e469db06cf897c3198297..05f711d03634f60bdd9362eb7656232b941bd10e 100644 --- a/documentations/fr/pages/configurations.md +++ b/documentations/fr/pages/configurations.md @@ -1,7 +1,7 @@ # **Configuration** !!! tip - Vous pouvez modifier les paramètres par défaut dans le fichier **config.yaml** situé dans le répertoire **./config/**. + Vous pouvez modifier les paramètres par défaut dans le fichier **config.yaml** situé dans le répertoire **./config/**. ## **Ressources** Modifiez pour correspondre à votre configuration matérielle @@ -96,4 +96,4 @@ Modifiez pour correspondre à votre configuration matérielle - **yaml*** : chemins/noms/versions des environnements conda _(par défaut : workflow/environments/{tools}_v.{version}.yaml)_ !!! note - Modifiez uniquement si vous souhaitez changer certains environnements (ex : tester une nouvelle version ou revenir à une ancienne). + Modifiez uniquement si vous souhaitez changer certains environnements (ex : tester une nouvelle version ou revenir à une ancienne). diff --git a/documentations/fr/pages/installations.md b/documentations/fr/pages/installations.md index 679d963c19dfa0cd861b2fb59dcbdef74cf74b3a..f29b56acc70209b236573b69ebb8e142435a126a 100644 --- a/documentations/fr/pages/installations.md +++ b/documentations/fr/pages/installations.md @@ -18,29 +18,29 @@ Vous pouvez **télécharger** et **installer** la dernière version de **Minifor !!! shell _Exemple de script pour les systèmes Linux\_x86\_64 bits ou Sous-système Windows pour Linux (WSL)_ ```shell - # Download + # Téléchargement curl -L -O https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh - # Install + # Installation bash ./Miniforge3-Linux-x86_64.sh -b -p ~/miniforge3/ - # Clean + # Nettoyage rm -f ./Miniforge3-Linux-x86_64.sh - # Configure + # Configuration ~/miniforge3/condabin/conda config --add channels bioconda /miniforge3/condabin/conda config --add channels conda-forge ~/miniforge3/condabin/conda config --set channel_priority strict ~/miniforge3/condabin/conda config --set auto_activate_base false - # Update + # Mise à jour ~/miniforge3/condabin/conda update conda --yes - # Check install + # Contrôle l'installation ~/miniforge3/condabin/conda --version ~/miniforge3/condabin/conda config --show channels - # Init + # Initialisation ~/miniforge3/condabin/conda init ``` @@ -62,17 +62,20 @@ Vous pouvez **télécharger** GeVarLi en tant que fichier zip depuis le dépôt !!! shell _Exemple de script pour télécharger GeVarLi dans votre répertoire ```/home/```_ ```shell - # Download + # Téléchargement curl https://forge.ird.fr/transvihmi/nfernandez/GeVarLi/-/archive/main/GeVarLi-main.tar.gz -o ~/GeVarLi-main.tar.gz # Untar tar -xzvf ~/GeVarLi-main.tar.gz - # Clean + # Nettoyer l'archive rm -f ~/GeVarLi-main.tar.gz - # Rename + # Renomer le répertoire mv ~/GeVarLi-main/ ~/GeVarLi/ + + # Se déplacer dans le répertoire GeVarLi + cd ~/GeVarLi/ ``` !!! tip @@ -80,10 +83,10 @@ Vous pouvez **télécharger** GeVarLi en tant que fichier zip depuis le dépôt _Exemple de script pour le cloner et le mettre à jour, dans votre répertoire ```/home/```_ ```shell - # Clone + # Cloner git clone --depth 1 https://forge.ird.fr/transvihmi/nfernandez/GeVarLi.git ~/GeVarLi/ cd ~/GeVarLi/ - # Update/Pull (présumant que vous êtes dans le répertoire GeVarLi/) + # Mise à jour avec un 'git pull' (présumant que vous êtes dans le répertoire GeVarLi/) git reset --hard HEAD && git pull --depth 1 --verbose ``` diff --git a/documentations/fr/pages/usage.md b/documentations/fr/pages/usage.md index c3fb5940c6c3e9f8b3e7489f03edcdc0b247056f..cf7f9a3b2f35dce4e0a0996a0c2765c2cf62100d 100644 --- a/documentations/fr/pages/usage.md +++ b/documentations/fr/pages/usage.md @@ -14,10 +14,11 @@ Pour lancer votre première analyse : - soit avec un clic droit > Ouvrir avec > Terminal.app, - soit avec l’interface CLI depuis un terminal : -Exemple de script: -```shell -./Run_GeVarLi.sh -``` +!!! shell + _Exemple de script lançant GeVarLi_ + ```shell + ./Run_GeVarLi.sh + ``` !!! warning Si vos lectures ont été générées avec un **protocole d’amplification**, vous devrez également fournir les **coordonnées des amorces d’amplification** au format **BEDPE**, afin que les **amorces soient correctement retirées** en utilisant **bamclipper**. @@ -133,8 +134,9 @@ Exemple de script: │ └── 📦 SARS-CoV-2_Omicron-BA1_Covid-Seq-Lib-on-MiSeq_250000-reads_R2.fastq.gz │ └── 📂 documentation/ - ├── mkdocs.yaml - ├── extra.css + │ + ├── âš™ï¸ mkdocs.yaml + ├── 🌠extra.css │ ├── 📂 images/ │ │ @@ -146,13 +148,35 @@ Exemple de script: │ ├── 📂 en/ │ │ - │ ├── index.md + │ ├── 📚 index.md │ │ │ └── 📂 pages/ + │ │ + │ ├── 📚 acknowledgedments.md + │ ├── 📚 afroscreen + │ ├── 📚 configurations.md + │ ├── 📚 contributions.md + │ ├── 📚 features.md + │ ├── 📚 glossary.md + │ ├── 📚 installations.md + │ ├── 📚 references.md + │ ├── 📚 results.md + │ └── 📚 usage.md │ └── 📂 fr/ │ - ├── index.md + ├── 📚 index.md │ - └── pages/ + └── 📂 pages/ + │ + ├── 📚 acknowledgedments.md + ├── 📚 afroscreen + ├── 📚 configurations.md + ├── 📚 contributions.md + ├── 📚 features.md + ├── 📚 glossary.md + ├── 📚 installations.md + ├── 📚 references.md + ├── 📚 results.md + └── 📚 usage.md ```