Edited wiki page RIO through web user interface.
[jalview.git] / wiki / RIO.wiki
1 #summary resampled inference of orthologs
2
3 = RIO: Resampled Inference of Orthologs =
4
5 == Purpose ==
6
7 RIO (Resampled Inference of Orthologs) is a method for automated phylogenomics based on explicit phylogenetic inference. RIO analyses are performed over resampled phylogenetic trees to estimate the reliability of orthology assignments.
8
9 == Usage == 
10 {{{
11 java -Xmx2048m -cp forester.jar org.forester.application.rio [options] <gene trees file> <species tree file> [outfile]
12 }}}
13 === Options ===
14
15   * -co: cutoff for ortholog output (default: 50) 
16   
17   * -t : file-name for output table of all vs. all ortholgy support
18   
19   * -q : name for query (sequence/node), if this is used, `[`outfile`]` is required as well
20
21   * -s : sort (default: 2)
22
23   * -u : to output ultra-paralogs (species specific expansions/paralogs)
24
25   * -cu: cutoff for ultra-paralog output (default: 50)
26
27 ==== Note ====
28
29 Either output of all vs. all ortholgy support with -t=`<`output table`>`and/or output for 
30 one query sequence with -q and a  `[`outfile`]` are required.
31
32 ==== Sort ====
33
34   * 0: orthologies
35   * 1: orthologies > super orthologies
36   * 2: super orthologies > orthologies
37
38 ==== Gene trees ====
39 The gene trees ideally are in [http://www.biomedcentral.com/1471-2105/10/356/ phyloXML] format, with taxonomy and sequence data in appropriate fields; but can also be in New Hamphshire (Newick) or Nexus format, as long as species information can be extracted from the gene names (e.g. "HUMAN" from "BCL2_HUMAN").
40
41 ==== Species tree ====
42 Must be in [http://www.biomedcentral.com/1471-2105/10/356/ phyloXML] format ([http://forester.googlecode.com/files/species.xml example]).
43
44
45 === Examples ===
46 `rio gene_trees.nh species.xml outfile -q=BCL2_HUMAN -t=outtable -u -cu=60 -co=60`
47
48 `rio gene_trees.nh species.xml -t=outtable`
49
50
51 <wiki:comment>
52 === Example files ===
53   * [http://forester.googlecode.com/files/wnt_gene_tree.xml gene tree]
54   * [http://forester.googlecode.com/files/species.xml species tree]
55   * [http://forester.googlecode.com/files/wnt_gsdi_log.txt log file (output)]
56 </wiki:comment>
57
58 == References ==
59
60 Zmasek CM and Eddy SR "RIO: Analyzing proteomes by automated phylogenomics using resampled inference of orthologs" [http://www.biomedcentral.com/1471-2105/3/14/ BMC Bioinformatics 2002, 3:14]
61
62 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]
63
64 Han M and Zmasek CM "phyloXML: XML for evolutionary biology and comparative genomics" [http://www.biomedcentral.com/1471-2105/10/356/ BMC Bioinformatics 2009, 10:356]
65  
66
67 == Download ==
68
69 Download forester.jar here: http://code.google.com/p/forester/downloads/list