BEAST v2.5.0 Documentation: beast.evolution.likelihood.ThreadedTreeLikelihood

BEASTObject that performs calculations based on the State.
Probabilistic representation that can produce a log probability for instance for running an MCMC chain.
Generic tree likelihood for an alignment given a generic SiteModel, a beast tree and a branch rate model
Calculates the likelihood of sequence data on a beast.tree given a site and substitution model using a variant of the 'peeling algorithm'. For details, seeFelsenstein, Joseph (1981). Evolutionary trees from DNA sequences: a maximum likelihood approach. J Mol Evol 17 (6): 368-376.

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

Inputs:

useAmbiguities, threads, proportions, scaling, data, tree, siteModel, branchRateModel, *

 

useAmbiguities
type: java.lang.Boolean
flag to indicate leafs that sites containing ambiguous states should be handled instead of ignored (the default)
Optional input. Default: false

 

threads
type: java.lang.Integer
maximum number of threads to use, if less than 1 the number of threads in BeastMCMC is used (default -1)
Optional input. Default: -1

 

proportions
type: java.lang.String
specifies proportions of patterns used per thread as space delimited string. This is useful when using a mixture of BEAGLE devices that run at different speeds, e.g GPU and CPU. The string is duplicated if there are more threads than proportions specified. For example, '1 2' as well as '33 66' with 2 threads specifies that the first thread gets a third of the patterns and the second two thirds. With 3 threads, it is interpreted as '1 2 1' = 25%, 50%, 25% and with 7 threads it is '1 2 1 2 1 2 1' = 10% 20% 10% 20% 10% 20% 10%. If not specified, all threads get the same proportion of patterns.
Optional input

 

scaling
type: beast.evolution.likelihood.ThreadedTreeLikelihood$Scaling
type of scaling to use, one of [none, always, _default]. If not specified, the -beagle_scaling flag is used.
Optional input

 

data
type: beast.evolution.alignment.Alignment
sequence data for the beast.tree
Required input

 

tree
type: beast.evolution.tree.TreeInterface
phylogenetic beast.tree with sequence data in the leafs
Required input

 

siteModel
type: beast.evolution.sitemodel.SiteModelInterface
site model for leafs in the beast.tree
Required input

 

branchRateModel
type: beast.evolution.branchratemodel.BranchRateModel$Base
A model describing the rates on the branches of the beast.tree.
Optional input

 

*
type: ?
Optional input