R: Split matching

match {TreeTools} | R Documentation

## 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

    match(x, table, ...)

    ## S3 method for class 'Splits'
    match(x, table, ...)

    ## S3 method for class 'list'
    match(x, table, ...)

    x %in% table

    ## S3 method for class 'Splits'
    x %in% table

    in.Splits(x, table)

### Arguments

`x, table` | Object of class `Splits`.
`...` | Specify `nomatch =` to provide an integer value that will be used in place of `NA` in the case where no match is found.

### Details

`in.Splits()` is an alias for `%in%`, included for backwards compatibility. It will be deprecated 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.

`%in%` returns a logical vector specifying which of the splits in `x` are present in `table`.

### See Also

Corresponding base functions are documented in `match()`.

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

### Examples

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

    match(splits1, splits2)
    splits1 %in% splits2

[Package TreeTools version 1.5.1 Index]