From 669e6993a9a16a09e8844b596b617283fc4947bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20FERNANDEZ=20NU=C3=91EZ?= <nicolas.fernandez@ird.fr> Date: Mon, 6 Jan 2025 12:00:31 +0100 Subject: [PATCH] Doc: Add french results --- documentations/en/pages/features.md | 16 ++++++++-------- documentations/en/pages/results.md | 19 ++++++++----------- documentations/fr/pages/results.md | 8 +++----- documentations/mkdocs.yaml | 4 ++-- 4 files changed, 21 insertions(+), 26 deletions(-) diff --git a/documentations/en/pages/features.md b/documentations/en/pages/features.md index 5eaa7c3..470cb23 100644 --- a/documentations/en/pages/features.md +++ b/documentations/en/pages/features.md @@ -1,18 +1,18 @@ # Features and tools ## Workflow management - - Workflow ......................... Snakemake - - Environments ..................... Miniforge _(Conda)_ + - Workflow _ _ _ _ _ _ _ _ _ _ _ _ _ Snakemake + - Environments _ _ _ _ _ _ _ _ _ _ _ Miniforge _(Conda)_ ## Reads quality control - - Contamination checking ........... Fastq-Screen - - Reads qualities metrics .......... FastQC - - HTML reporting ................... MultiQC + - Contamination checking _ _ _ _ _ _ Fastq-Screen + - Reads qualities metrics _ _ _ _ _ FastQC + - HTML reporting _ _ _ _ _ _ _ _ _ _ MultiQC ## Reads cleaning - - Illumina adpters trimming ........ Cutadapt - - Amplicon primers trimming ........ Cutadapt _('hard-clipping')_ - - Reads quality trimming ........... Sickle-trim + - Illumina adpters trimming _ _ _ _ Cutadapt + - Amplicon primers trimming _ _ _ _ Cutadapt _('hard-clipping')_ + - Reads quality trimming _ _ _ _ _ _ Sickle-trim ## Reads mapping - Indexing genomes ................. BWA _(or minimap2, or bowtie2)_ diff --git a/documentations/en/pages/results.md b/documentations/en/pages/results.md index 84b8642..0ceb47a 100644 --- a/documentations/en/pages/results.md +++ b/documentations/en/pages/results.md @@ -3,18 +3,16 @@ Results are available in **./results/** directry. !!! tip - Files tagged as [temp] are removed by default, to save disk usage. - If you want to keep it, please edit configuration file. - + Files tagged as **[temp]** are removed by default, to save disk usage. + If you want to keep them, please edit the **configuration** file. !!! note - Files tree: -```shell - 🧩 GeVarLi/ - └── 📂 results/ - ├── 🧬 All_{REFERENCE}_consensus_sequences.fasta - ├── 📊 All_{REFERENCE}_genome_coverages.tsv - ├── 📊 All_{REFERENCE}_nextclade_lineages.tsv + **Files tree** + 🧩 GeVarLi/ + └── 📂 results/ + ├── 🧬 All_{REFERENCE}_consensus_sequences.fasta + ├── 📊 All_{REFERENCE}_genome_coverages.tsv + ├── 📊 All_{REFERENCE}_nextclade_lineages.tsv ├── 📊 All_{REFERENCE}_pangolin_lineages.tsv ├── 🌠All_readsQC_reports.html ├── 📂 00_Quality_Control/ @@ -92,4 +90,3 @@ Results are available in **./results/** directry.  └── 📂 tools-log/  ├── 📂 awk/   ├── 📂 {TOOL}/ -``` diff --git a/documentations/fr/pages/results.md b/documentations/fr/pages/results.md index e144569..8432e74 100644 --- a/documentations/fr/pages/results.md +++ b/documentations/fr/pages/results.md @@ -3,15 +3,13 @@ Les résultats sont disponible dans le répertoire **./results/** , organisés comme ceci !!! note - Les fichiers étiqueté comme [temp] sont supprimés par défaut, afin de préserver l'espace disque. - Si vous souhaiter les conserver, veuiller éditer le fichier de configuration. + Les fichiers étiqueté comme **[temp]** sont supprimés par défaut, afin de préserver l'espace disque. + Si vous souhaiter les conserver, veuiller éditer le fichier de **configuration**. !!! note - Arborescence des fichiers: - - ```shell + **Arborescence des fichiers** 🧩 GeVarLi/ └── 📂 results/ ├── 🧬 All_{REFERENCE}_consensus_sequences.fasta diff --git a/documentations/mkdocs.yaml b/documentations/mkdocs.yaml index 3c53246..c8d360d 100644 --- a/documentations/mkdocs.yaml +++ b/documentations/mkdocs.yaml @@ -121,9 +121,9 @@ nav: - Acknowledgements: en/pages/acknowledgements.md - Accueil (fr): - À propos: fr/index.md - - Caractéristiques: fr/pages/features.md + - Fonctionnalités: fr/pages/features.md - Installations: fr/pages/installations.md - - Configuration: fr/pages/setup.md + - Configuration: fr/pages/configuration.md - Utilisation: fr/pages/usage.md - Résultats: fr/pages/results.md - Glossaire: fr/pages/glossary.md -- GitLab