TreeSearch (version 0.4.0)

MorphyBootstrap: Ratchet bootstrapper

Description

Ratchet bootstrapper

Usage

MorphyBootstrap(edgeList, morphyObj, EdgeSwapper = NNISwap, maxIter,
  maxHits, verbosity = 1L, stopAtPeak = FALSE, stopAtPlateau = 0L,
  ...)

ProfileBootstrap(edgeList, dataset, EdgeSwapper = NNISwap, maxIter, maxHits, verbosity = 1L, ...)

IWBootstrap(edgeList, dataset, concavity = 10L, EdgeSwapper = NNISwap, maxIter, maxHits, verbosity = 1L, ...)

Arguments

edgeList

a list containing the following: - vector of integers corresponding to the parent of each edge in turn - vector of integers corresponding to the child of each edge in turn - (optionally) score of the tree - (optionally, if score provided) number of times this score has been hit

morphyObj

Object of class morphy, perhaps created with PhyDat2Morphy().

EdgeSwapper

a function that rearranges a parent and child vector, and returns a list with modified vectors; for example SPRSwap().

maxIter

maximum number of iterations to perform in tree search

maxHits

maximum number of hits to accomplish in tree search

verbosity

Level of detail to display in console: larger numbers provide more verbose feedback to the user.

stopAtPeak

Logical specifying whether to terminate search once a subsequent iteration recovers a sub-optimal score. Useful with methods that return all trees one rearrangement from the current tree, such as AllTBR(). Will be overridden if a passed function has an attribute stopAtPeak set by attr(FunctionName, 'stopAtPeak') <- TRUE.

stopAtPlateau

Integer. If > 0, tree search will terminate if the score has not improved after stopAtPlateau iterations. Useful with methods that return all trees one rearrangement from the current tree, such as AllTBR(). Will be overridden if a passed function has an attribute stopAtPlateau set by attr(FunctionName, 'stopAtPlateau') <- TRUE.

further parameters to send to TreeScorer()

dataset

A phylogenetic data matrix of class phyDat, whose names correspond to the labels of any accompanying tree.

concavity

A numeric value to use as the concavity constant (k) in implied weighting. Defaults to 10; TNT sets a default of 3, but this is too low in some circumstances (Smith, 2019).

Value

A tree that is optimal under a random sampling of the original characters

Functions

  • ProfileBootstrap: Bootstrapper for Profile Parsimony

  • IWBootstrap: Bootstrapper for Implied weighting

References

  • SmithTernTreeSearch