match.Splits: Split matching

In TreeTools: Create, Modify and Analyse Phylogenetic Trees

Split matching

Description

match() returns a vector of the positions of (first) matches of splits in its first argument in its second. %in% is a more intuitive interface as a binary operator, which returns a logical vector indicating whether there is a match or not for each split in its left operand.

Usage

## S4 method for signature 'Splits,Splits'
match(x, table, nomatch = NA_integer_, incomparables = NULL)

match(x, table, nomatch = NA_integer_, incomparables = NULL)

## S4 method for signature 'Splits,Splits'
x %in% table

FirstMatchingSplit(x, table, nomatch, return = c("x", "table", "both"))

Arguments

x, table	Splits objects
nomatch	Integer value that will be used in place of NA in the case where no match is found.
incomparables	Ignored. (Included for consistency with generic.)
return	Which index to return: in x, in table, or both

Value

match() returns an integer vector specifying the position in table that matches each element in x, or nomatch if no match is found.

FirstMatchingSplit() returns an integer (or length-2 integer if return = "both") specifying the first split in x to have a match in table (return = "x"), or the index of that match (return = "table"). nomatch (default 0) is returned in the absence of a match.

See Also

Corresponding base functions are documented in match().

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

Examples

splits1 <- as.Splits(BalancedTree(7))
splits2 <- as.Splits(PectinateTree(7))

match(splits1, splits2)

TreeTools documentation built on April 23, 2026, 5:06 p.m.