BEAST v2.7.8 Documentation: starbeast3.core.SpeciesTreeLogger

Logs tree annotated with metadata in StarBeast format

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

Inputs:

tree, popSize, popSizeTop, speciesTreePrior, treetop, metadata, sort

 

tree
type: beast.base.evolution.tree.Tree
tree to be logged
Required input

 

popSize
type: beast.base.core.Function
population size parameter associated with tree nodes
Required input

 

popSizeTop
type: beast.base.core.Function
population size parameter associated with top of tree branches, only used for non-constant *beast analysis
Optional input

 

speciesTreePrior
type: starbeast3.evolution.speciation.SpeciesTreePrior
species tree prior, used to find which Population Size Function is used. If not specified, assumes 'constant'
Optional input

 

treetop
type: beast.base.evolution.speciation.TreeTopFinder
calculates height of species tree
Required input

 

metadata
type: beast.base.core.Function***
meta data to be logged with the tree nodes
Optional input

 

sort
type: java.lang.Boolean
whether to sort the tree before logging.
Optional input. Default: true