BEAST v2.7.8 Documentation: beastlabs.evolution.tree.TreeDistanceLogger

BEASTObject that performs calculations based on the State.
Logger to report statistics of a tree

Logable: yes, this can be used in a log.

Inputs:

tree, ref, treelogger, bootstraps, psites, metric

 

tree
type: beast.base.evolution.tree.Tree
Tree to report height for.
Optional input

 

ref
type: beast.base.evolution.tree.Tree
Reference tree to calculate distances from (default: the initial tree).
Optional input

 

treelogger
type: beast.base.inference.Logger
The tree logger. This is only required if the distance to the initial tree is being calculated, and the user is resuming
Optional input

 

bootstraps
type: java.lang.Integer
Number of reference trees to use where each is based on a different sample of the alignment. Set to 0 to use full alignment without bootstrapping.
Optional input. Default: 0

 

psites
type: java.lang.Double
Proportion of sites to sample when bootstraping. Set to 0 for random number of sites per seq
Optional input. Default: 1.0

 

metric
type: beastlabs.evolution.tree.TreeDistanceLogger$metric
Tree distance metric (default RNNI)
Optional input