| tssInfo {poweRbal} | R Documentation |
Tree shape statistics
Description
tssInfo - List that provides information on available tree shape
statistics (TSS) from the package 'treebalance'.
Most of them are either balance or imbalance indices. The indices are grouped
by their families and otherwise sorted alphabetically by their full names.
The following information is provided:
short: Abbreviation of the name (plain characters).
simple: Simplified full name (plain characters).
name: Full name (partly expressions as some names use special symbols).
func: Function of the TSS.
type: Either "tss", "bali", or "imbali" expressing what type of tree shape statistic it is.
only_binary: TRUE if TSS is suitable only for binary trees, FALSE if also applicable to arbitrary rooted trees.
safe_n : Integer vector with two entries specifying the range of leaf numbers
nfor which the TSS can be (safely) used, without warnings for too few leaves or values reaching Inf for too many leaves.
c(4,800), for example means that this TSS should only be applied on trees with 4 to 800 leaves. 'Inf' as the second entry means that there is no specific upper limit, but that the size of the tree itself and the computation time are the limiting factors.
col: Color for the TSS (related TSS have similar colors).
Usage
tssInfo
Format
An object of class list of length 29.
Author(s)
Sophie Kersting
References
M. Fischer, L.Herbst, S. J. Kersting, L. Kühn, and K. Wicke, Tree Balance Indices - A Comprehensive Survey. Springer, 2023. ISBN: 978-3-031-39799-8
Examples
tssInfo$ALD$name
tssInfo$ALD$func(genYuleTree(6))