Edited wiki page RIO through web user interface.

[jalview.git] / wiki / RIO.wiki

diff --git a/wiki/RIO.wiki b/wiki/RIO.wiki
index e9ca2dd..30051ea 100644 (file)
--- a/wiki/RIO.wiki
+++ b/wiki/RIO.wiki
@@ -13,8 +13,11 @@ java -Xmx2048m -cp forester.jar org.forester.application.rio [options] <gene tre
 }}}
 
 === Options ===
-
-  * -b : to use SDIR instead of GSDIR (faster, but non-binary species trees are disallowed) 
+  * `-f=<first>` : first gene tree to analyze (0-based index) (default: analyze all gene trees)
+  * `-l=<last>` : last gene tree to analyze (0-based index) (default: analyze all gene trees)
+  * `-r=<re-rooting>` : re-rooting method for gene trees, possible values or 'none', 'midpoint', or 'outgroup' (default: by minizming duplications)
+  * `-o=<outgroup>` : for rooting by outgroup, name of outgroup (external gene tree node)
+  * `-b` : to use SDIR instead of GSDIR (faster, but non-binary species trees are disallowed) 
 
   
 ==== Gene trees ====
@@ -23,13 +26,14 @@ All gene trees must be *completely binary*.
 
 
 ==== Species tree ====
-Must be in [http://www.biomedcentral.com/1471-2105/10/356/ phyloXML] format ([http://forester.googlecode.com/files/species_tree_rio.xml example]). 
-The species tree is allowed to have nodes with more than two descendents (polytomies) as long as GSDIR ([GSDI GSDI] re-rooting) algorithm is used. 
+The species tree ideally is in [http://www.biomedcentral.com/1471-2105/10/356/ phyloXML] format, but can also be in New Hamphshire (Newick) or Nexus format  ([http://forester.googlecode.com/files/species_tree_rio.xml example]). 
+The species tree is allowed to have nodes with more than two descendants (polytomies), as long as the (slower) GSDIR ([GSDI GSDI] re-rooting) algorithm is used. 
 
 
-=== Example ===
+=== Examples ===
 `rio gene_trees.nh species.xml outtable.tsv log.txt`
 
+`rio gene_trees.nh species.xml outtable.tsv log.txt -r=outgroup -o=XVL1_ECOLI`
 
 === Example files ===
   * [http://forester.googlecode.com/files/gene_trees_rio.nh gene trees file]