4d831001476c673701ff38da833c0d9da5e37ccd
[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
15 === Options ===
16
17   * -g: to allow stripping of gene tree nodes without a matching species in the species tree
18  
19   * -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
20   * -q: to allow species tree in other formats than phyloXML (i.e. Newick, NHX, Nexus)
21   * -b: to use SDIse algorithm instead of GSDI algorithm (for binary species trees)
22
23 ==== Gene tree ====
24 Must be in phyloXM format, with taxonomy and sequence data in appropriate fields.
25
26 ==== Species tree ====
27 Must be in phyloXML format unless option -q is used.
28
29 === Output ===
30
31 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:
32   * a log file, ending in `"_gsdi_log.txt"`
33   * a species tree file which only contains external nodes with were needed for the reconciliation, ending in `_species_tree_used.xml`
34   * 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'.
35
36 === Example ===
37 gsdi -g gene_tree.xml tree_of_life.xml out.xml
38
39
40
41 == Reference ==
42
43 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]
44  
45
46
47 == Download ==
48
49 Download forester.jar here: http://code.google.com/p/forester/downloads/list