poweRbal (version 0.0.1.1)

getTSSnames: Get information on included tree shape statistics

Description

getTSSnames - Returns the full names (character/expression) of the TSS.

getTSSsimple - Returns the simple names (character/expression) of the TSS.

getTSScolors - Returns the colors of the TSS.

getTSSsafe_n - Returns the ranges of n that can be safely used.

getTSStype - Returns the types of the TSS, i.e., whether they are balance or imbalance indices, or simple tree shape statistics.

getTSSonly_bin - Returns TRUE/FALSE vector: TRUE if TSS is only for binary trees and FALSE otherwise.

getAllTSS - Returns the short names of all TSS that are safe to use for the specified n, have one of the specified types and can be applied to (non-)binary trees (not_only_bin).

Usage

getTSSnames(tss_shorts)
getTSSsimple(tss_shorts)
getTSScolors(tss_shorts)
getTSSsafe_n(tss_shorts)
getTSStype(tss_shorts)
getTSSonly_bin(tss_shorts)
getAllTSS(n = NULL, not_only_bin = FALSE, types = c("tss", "bali", "imbali"))

Value

getTSSnames Vector of characters/expressions.

getTSSsimple Vector of characters/expressions.

getTSScolors Vector of characters (color names).

getTSSsafe_n Numeric matrix, one row per TSS and two columns with lower and upper limit.

getTSStype Vector of characters (types as factors).

getTSSonly_bin Logical vector.

getAllTSS Character vector of short names of TSS contained in tssInfo.

Arguments

tss_shorts

Vector of short names (characters) of TSS contained in tssInfo.

n

Integer value or vector of integer values, that specifies the number(s) of leaves. If NULL (default), then getAllSafeTSS returns the short names of all TSS contained in tssInfo.

not_only_bin

Select TRUE if you also want to analyze non-binary trees and therefore want to filter out any TSS that only work on binary trees. Otherwise, select FALSE (default) if all TSS are applicable.

types

Character vector, that specifies all permissible TSS types. The vector may contain a subset of c("tss", "bali", "imbali") to indicate if balance indices, imbalance indices or mere TSS should be included. By default all types are permissible.

Examples

getTSSnames(tss_shorts = c("Sackin", "Colless", "B1I"))
getTSSsimple(tss_shorts = c("Sackin", "Colless", "B1I"))
getTSScolors(tss_shorts = c("Sackin", "Colless", "B1I"))
getTSSsafe_n(tss_shorts = c("Sackin", "Colless", "B1I"))
getTSStype(tss_shorts = c("Sackin", "Colless", "B1I"))
getTSSonly_bin(tss_shorts = c("Sackin", "Colless", "B1I"))
getAllTSS(n = c(3,30))