Edited wiki page GSDI through web user interface.

[jalview.git] / wiki / GSDI.wiki

diff --git a/wiki/GSDI.wiki b/wiki/GSDI.wiki
index 2d6c3ae..0f57750 100644 (file)
--- a/wiki/GSDI.wiki
+++ b/wiki/GSDI.wiki
@@ -9,26 +9,44 @@ To infer duplication events on a gene tree given a trusted species tree.
 == Usage == 
 {{{
 java -Xmx1024m -cp
-path/to/forester.jar org.forester.application.gsdi [-options] <gene tree in phyloXML format> <species tree> [outfile]
+path/to/forester.jar org.forester.application.gsdi [-options] <gene tree in phyloXML format> <species tree> <outfile>
 }}}
-
 === Options ===
 
-  * -s: to strip the species tree prior to duplication inference
-  * -b: to use SDI algorithm instead of GSDI algorithm
-  * -m: use most parimonious duplication model for GSDI: assign nodes as speciations which would otherwise be assiged as unknown because of polytomies in the species tree
-  * -q: to allow species tree in other formats than phyloXML (Newick, NHX, Nexus)
+  * -g: to allow stripping of gene tree nodes without a matching species in the species tree
+ 
+  * -m: use most parimonious duplication model for GSDI: assign nodes as speciations which would otherwise be assiged as potential duplications due tp polytomies in the species tree
 
-==== Species tree ====
-In phyloXML format (unless option -q is used), with taxonomy data in appropriate fields. Must be rooted, polytomies are allowed.
+  * -q: to allow species tree in other formats than phyloXML (i.e. Newick, NHX, Nexus)
+
+  * -b: to use SDIse algorithm instead of GSDI algorithm (for binary species trees)
 
 ==== Gene tree ====
-In phyloXML format, with taxonomy and sequence data in appropriate fields. Must be rooted an binary (no polytomies).
+Must be in phyloXM format, with taxonomy and sequence data in appropriate fields.
+
+==== Species tree ====
+Must be in phyloXML format unless option -q is used.
+
+=== Output ===
+
+Besides the main output of a gene tree with duplications and speciations assigned to all of its internal nodes, this program also produces the following:
+  * a log file, ending in `"_gsdi_log.txt"`
+  * a species tree file which only contains external nodes with were needed for the reconciliation, ending in `"_species_tree_used.xml"`
+  * if the gene tree contains species with scientific species names such as "Pyrococcus horikoshii strain ATCC 700860" and if a mapping cannot be establish based on these, GSDI will attempt to map by removing the "strain" (or "subspecies") information, these will be listed in a file ending in `"_gsdi_remapped.txt"`.
+
+=== Taxonomic mapping between gene and species tree ===
+
+GSDI can establish a taxonomic mapping between gene and species tree on the following three data fields:
+  * scientific names (e.g. "Pyrococcus horikoshii")
+  * taxonomic identifiers (e.g. "35932" from uniprot or ncbi)
+  * taxonomy codes (e.g. "PYRHO") 
+
+
 
+=== Example ===
+`gsdi -g -q gene_tree.xml tree_of_life.nwk out.xml`
 
-== Description ==
 
-Currently, GSDI strips the gene tree of nodes for which a matching species is not present in the species tree. 
 
 == Reference ==