R: Maximum splits in an _n_-leaf tree

SplitsInBinaryTree {TreeTools} | R Documentation

## Maximum splits in an n-leaf tree

### Description

`SplitsInBinaryTree()` is a convenience function to calculate the number of splits in a fully-resolved (binary) tree with n leaves.

### Usage

    SplitsInBinaryTree(tree)

    ## S3 method for class 'phylo'
    SplitsInBinaryTree(tree)

    ## S3 method for class 'Splits'
    SplitsInBinaryTree(tree)

    ## S3 method for class 'list'
    SplitsInBinaryTree(tree)

    ## S3 method for class 'multiPhylo'
    SplitsInBinaryTree(tree)

    ## S3 method for class 'numeric'
    SplitsInBinaryTree(tree)

### Arguments

`tree` | An object of a supported format that represents a tree or set of trees, from which the number of leaves will be calculated.

### Value

`SplitsInBinaryTree()` returns an integer vector detailing the number of unique non-trivial splits in a binary tree with n leaves.

### Author(s)

Martin R. Smith (martin.smith@durham.ac.uk)

### See Also

Other tree properties: `ConsensusWithout()`, `NSplits()`, `NTip()`, `TipLabels()`, `TreeIsRooted()`

Other Splits operations: `NSplits()`, `NTip()`, `TipLabels()`, `TipsInSplits()`, `as.Splits()`, `match()`

### Examples

    tree <- TreeTools::BalancedTree(8)
    SplitsInBinaryTree(tree)
    SplitsInBinaryTree(TreeTools::as.Splits(tree))
    SplitsInBinaryTree(8)
    SplitsInBinaryTree(list(tree, tree))

[Package TreeTools version 1.2.0 Index]