Edited wiki page GSDI through web user interface.
[jalview.git] / wiki / GSDI.wiki
1 #summary generalized speciation duplication inference
2
3 = Generalized Speciation Duplication Inference =
4
5 == Purpose ==
6
7 To infer duplication events on a gene tree given a trusted species tree.
8
9 == Usage == 
10
11 `java -Xmx1024m -cp
12 path/to/forester.jar org.forester.application.gsdi [-options] <gene tree in phyloXML format> <species tree> <outfile>`
13
14 === Options ===
15
16   * -g: to allow stripping of gene tree nodes without a matching species in the species tree
17  
18   * -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
19   * -q: to allow species tree in other formats than phyloXML (i.e. Newick, NHX, Nexus)
20   * -b: to use SDIse algorithm instead of GSDI algorithm (for binary species trees)
21
22 ==== Gene tree ====
23 Must be in phyloXM format, with taxonomy and sequence data in appropriate fields.
24
25 ==== Species tree ====
26 Must be in phyloXML format unless option -q is used.
27
28 === Output ===
29
30 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:
31   * a log file, ending in `"_gsdi_log.txt"`
32   * a species tree file which only contains external nodes with were needed for the reconciliation, ending in `"_species_tree_used.xml"`
33   * if the gene tree contains species with scientific species names such as "Pyrococcus horikoshii strain ATCC 700860" and if a mapping cannot be establish bases 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"`.
34
35 === Example ===
36 `gsdi -g gene_tree.xml tree_of_life.xml out.xml`
37
38
39
40 == Reference ==
41
42 Zmasek CM and Eddy SR "A simple algorithm to infer gene duplication and speciation events on a gene tree" [http://bioinformatics.oxfordjournals.org/content/17/9/821.abstract Bioinformatics, 17, 821-828]
43  
44
45
46 == Download ==
47
48 Download forester.jar here: http://code.google.com/p/forester/downloads/list