R: Efficiently convert edge matrix to splits

edge_to_splits {TreeTools} | R Documentation

## Efficiently convert edge matrix to splits

### Description

Wrapper for internal C++ function for maximum efficiency. Improper input may crash R. Behaviour not guaranteed. It is advisable to contact the package maintainers before relying on this function.

### Usage

    edge_to_splits(
      edge,
      edgeOrder,
      tipLabels = NULL,
      asSplits = TRUE,
      nTip = NTip(edge),
      ...
    )

### Arguments

`edge` | A matrix with two columns, with each row listing the parent and child node of an edge in a phylogenetic tree. Property `edge` of objects of class `phylo`.
`edgeOrder` | Integer vector such that `edge[edgeOrder, ]` returns a postorder ordering of edges.
`tipLabels` | Character vector specifying sequence in which to order tip labels. Label order must (currently) match to combine or compare separate `Splits` objects.
`asSplits` | Logical specifying whether to return a `Splits` object, or an unannotated two-dimensional array (useful where performance is paramount).
`nTip` | Integer specifying number of leaves in tree.
`...` | Presently unused.

### Value

`edge_to_splits()` uses the same return format as `as.Splits()`.

### See Also

`as.Splits()` offers a safe access point to this function that should be suitable for most users.

[Package TreeTools version 1.7.0 Index]