From 9ccac94b1d03519d1f267628bf254da421d09fef Mon Sep 17 00:00:00 2001 From: catuskid Date: Tue, 13 Aug 2024 15:00:06 +0200 Subject: [PATCH] update readme --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 54502e6..a85316c 100755 --- a/README.md +++ b/README.md @@ -43,10 +43,30 @@ $ mkdir YourHogProfDirectory Ok. We're ready! Now let's compile a database containing all HOGs and our desired taxonomic levels using default settings. Launch the lshbuilder. dbtypes available on the command line are : all , plants , archaea, bacteria , eukarya , protists , fungi , metazoa and vertebrates. These will use the NCBI taxonomy as a tree to annotate events in different gene family's histories. +If you are using OMA releases after 2022 we will also be downloading the OMA taxonomic tree since it is more accurate than the NCBI tree. This will be used to annotate the events in the gene family histories. + +``` +wget https://omabrowser.org/All/speciestree.nwk + +``` + +If you are using an OMA release before 2022 you will need to use the NCBI tree. This is the default tree used by HogProf. + + + ``` $python lshbuilder.py --outpath YourHogProfDirectory --dbtype all --OMA YourOmaDirectory/OmaServer.h5 --nthreads numberOfCPUcores ``` + +Otherwise we can use the custom tree we downloaded. + +``` + +$python lshbuilder.py --outpath YourHogProfDirectory --dbtype all --OMA YourOmaDirectory/OmaServer.h5 --nthreads numberOfCPUcores --mastertree speciestree.nwk --reformat_names True + +``` + This should build a taxonomic tree for the genomes contained in the release and then calculate enhanced phylogenies for all HOGs in OMA. Once the database is completed it can be interogated using a profiler object. Construction and usage of this object should be done using a python script or notebook. This shown in the example notebook searchenrich.ipynb found in the examples. Please feel free to modify it to suit the needs of your own research.