TreeTools (version 1.6.0)

TipLabels: Extract tip labels

Description

TipLabels() extracts labels from an object: for example, names of taxa in a phylogenetic tree or data matrix. AllTipLabels() extracts all labels, where entries of a list of trees may pertain to different taxa.

Usage

TipLabels(x, single = TRUE)
# S3 method for matrix
TipLabels(x, single = TRUE)
# S3 method for phylo
TipLabels(x, single = TRUE)
# S3 method for default
TipLabels(x, single = TRUE)
# S3 method for phyDat
TipLabels(x, single = TRUE)
# S3 method for TreeNumber
TipLabels(x, single = TRUE)
# S3 method for Splits
TipLabels(x, single = TRUE)
# S3 method for list
TipLabels(x, single = FALSE)
AllTipLabels(x)
# S3 method for list
AllTipLabels(x)
# S3 method for multiPhylo
AllTipLabels(x)
# S3 method for phylo
AllTipLabels(x)
# S3 method for Splits
AllTipLabels(x)
# S3 method for TreeNumber
AllTipLabels(x)
# S3 method for matrix
AllTipLabels(x)
# S3 method for multiPhylo
TipLabels(x, single = FALSE)
# S3 method for character
TipLabels(x, single = TRUE)
# S3 method for numeric
TipLabels(x, single = TRUE)
# S3 method for phyDat
TipLabels(x, single = TRUE)
# S3 method for default
TipLabels(x, single = TRUE)

Arguments

x

An object of a supported class (see Usage section above).

single

Logical specifying whether to report the labels for the first object only (TRUE), or for each object in a list (FALSE).

Value

TipLabels() returns a character vector listing the tip labels appropriate to x. If x is a single integer, this will be a vector t1, t2 ... tx, to match the default of ape::rtree().

See Also

Other tree properties: ConsensusWithout(), NSplits(), NTip(), SplitsInBinaryTree(), TreeIsRooted()

Other Splits operations: LabelSplits(), NSplits(), NTip(), PolarizeSplits(), SplitFrequency(), SplitsInBinaryTree(), Splits, TipsInSplits(), match()

Examples

# NOT RUN {
TipLabels(BalancedTree(letters[5:1]))
TipLabels(5)

data('Lobo')
head(TipLabels(Lobo.phy))

AllTipLabels(c(BalancedTree(4), PectinateTree(8)))

# }