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)

in.Splits(x, table)

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

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

Arguments

x, table	Object of class Splits.
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.)

Details

in.Splits() is an alias for %in%, included for backwards compatibility. It is deprecated and will be removed in a future release.

Value

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

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 Aug. 8, 2025, 7:18 p.m.