Updated docs.

B-UMMI · Oct 27, 2023 · efee4a8 · efee4a8
1 parent ed0de96
commit efee4a8
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/CHEWBBACA/docs/user/help_support/faq.rst b/CHEWBBACA/docs/user/help_support/faq.rst
@@ -52,6 +52,16 @@ You can also download schemas compatible with chewBBACA from `Chewie-NS <https:/
 Chewie-NS allows chewBBACA users to download and update cg/wgMLST schemas, allowing the easy sharing of
 results, while ensuring the reproducibility and consistency of these steps.
 
+How can I identify genetic clusters based on the results generated by the AlleleCall module?
+............................................................................................
+We recommend that you use `ReporTree <https://github.com/insapathogenomics/ReporTree>`_ to identify genetic clusters
+based on the allelic profiles (contained in the ``results_alleles.tsv`` output file) determined by chewBBACA. ReporTree
+includes functionalities to identify genetic clusters at any distance threshold level(s), obtain summary reports with relevant
+statistics computed based on sample metadata, identify regions of cluster stability, etc. Cluster nomenclature can be maintained
+and updated in subsequent analyses, which is especially useful in surveillance-oriented workflows. Check the
+`publication <https://genomemedicine.biomedcentral.com/articles/10.1186/s13073-023-01196-1>`_ and the
+`GitHub repository <https://github.com/insapathogenomics/ReporTree>`_ to know more about ReporTree.
+
 Is it possible to perform allele calling without adding novel alleles to the schema?
 ....................................................................................
 Yes, you can use the ``--no-inferred`` parameter to specify that you do not want to add novel alleles

diff --git a/CHEWBBACA/docs/user/modules/AlleleCall.rst b/CHEWBBACA/docs/user/modules/AlleleCall.rst
@@ -412,6 +412,17 @@ Example for the ``SAMD00008628`` genome:
   algorithm to create a TSV file, ``results_alleles_hashed.tsv``, with hashed profiles (each allele identifier is substituted
   by the hash of the DNA sequence).
 
+Identify genetic clusters
+:::::::::::::::::::::::::
+
+We recommend that you use `ReporTree <https://github.com/insapathogenomics/ReporTree>`_ to identify genetic clusters
+based on the allelic profiles (contained in the ``results_alleles.tsv`` output file) determined by chewBBACA. ReporTree
+includes functionalities to identify genetic clusters at any distance threshold level(s), obtain summary reports with relevant
+statistics computed based on sample metadata, identify regions of cluster stability, etc. Cluster nomenclature can be maintained
+and updated in subsequent analyses, which is especially useful in surveillance-oriented workflows. Check the
+`publication <https://genomemedicine.biomedcentral.com/articles/10.1186/s13073-023-01196-1>`_ and the
+`GitHub repository <https://github.com/insapathogenomics/ReporTree>`_ to know more about ReporTree.
+
 Concurrent allele calling
 :::::::::::::::::::::::::