User Tools

Site Tools


configuration_file

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

configuration_file [2013/06/03 13:07]
mmarcet created
configuration_file [2013/06/03 13:17] (current)
mmarcet
Line 1: Line 1:
 ===== Configuration file ===== ===== Configuration file =====
  
-While TreeKo is able to run on default values, it is advisable to use a configuration file in order to adapt its use to the data. The configuration file can be used to change the rooting method, printing information or to limit the number of pruned trees allowed during the use of TreeKo. Lines starting with **#** will be regarded as comments. There are two kind of values in the configuration file. The True/False values consist in one tag which will enable/​disable the option. For instance, if we want to print the pruned trees generated for the trees, having one line saying “print_pruned_trees” will enable the option. When further information is needed, this should be put in a tab delimited line. For instance, the root method should be defined as: “root_method<​tab>​m”. Any information omitted in the file will be supplied by the default values. An example configuration file can be found {{configuration_file.txt|here}}.+While TreeKo is able to run on default values, it is advisable to use a configuration file in order to adapt its use to the data. The configuration file can be used to change the rooting method, printing information or to limit the number of pruned trees allowed during the use of TreeKo. Lines starting with **#** will be regarded as comments. There are two kind of values in the configuration file. The True/False values consist in one tag which will enable/​disable the option. For instance, if we want to print the pruned trees generated for the trees, having one line saying “print_pruned_trees” will enable the option. When further information is needed, this should be put in a tab delimited line. For instance, the root method should be defined as: “root_method<​tab>​m”. Any information omitted in the file will be supplied by the default values. An example configuration file can be found {{:configuration_file.txt.gz|here}}.
  
-==== Options ====+===== Options ​=====
  
 ==== Tree information:​ ==== ==== Tree information:​ ====
Line 244: Line 244:
 **Description**:​ **Description**:​
 It adds short descriptions to the output. By default this option is enabled. It adds short descriptions to the output. By default this option is enabled.
 +
 +----
 +
 +  * [[start|Starting page]]
 +  * [[documentation|How to run treeKO]]
 +  * [[Algorithm|Algorithm]]
 +  * [[inputfiles|Input Files]]
 +  * [[output | Output Files]]
 +  * [[downloads|Downloads]]
 +  * [[about | About]]
configuration_file.txt · Last modified: 2013/06/03 13:17 by mmarcet