R: Label splits

LabelSplits {TreeTools} | R Documentation

## Label splits

### Description

Labels the edges associated with each split on a plotted tree.

### Usage

    LabelSplits(tree, labels, unit = "", ...)

### Arguments

`tree` | A tree of class `phylo`.
`labels` | Named vector listing annotations for each split. Names should correspond to the node associated with each split; see `as.Splits()` for details.
`unit` | Character specifying units of `labels`, if desired. Include a leading space if necessary.
`...` | Additional parameters to `ape::edgelabels()`.

### Details

As the two root edges of a rooted tree denote the same split, only the rightmost (plotted at the bottom, by default) edge will be labelled. If the position of the root is significant, add a tip at the root using `AddTip()`.

### Value

`LabelSplits()` returns `invisible()`, after plotting `labels` on each relevant edge of a plot (which should already have been produced using `plot(tree)`).

### See Also

Calculate split support: `SplitFrequency()`

Colour labels according to value: `SupportColour()`

### Examples

    tree <- BalancedTree(LETTERS[1:5])
    splits <- as.Splits(tree)
    plot(tree)
    LabelSplits(tree, as.character(splits), frame = 'none', pos = 3L)
    LabelSplits(tree, TipsInSplits(splits), unit = ' tips', frame = 'none',
                pos = 1L)

    # An example forest of 100 trees, some identical
    forest <- as.phylo(c(1, rep(10, 79), rep(100, 15), rep(1000, 5)), nTip = 9)

    # Generate an 80% consensus tree
    cons <- ape::consensus(forest, p = 0.8)
    plot(cons)

    splitFreqs <- SplitFrequency(cons, forest)
    LabelSplits(cons, splitFreqs, unit = '%',
                col = SupportColor(splitFreqs / 100),
                frame = 'none', pos = 3L)

[Package TreeTools version 1.2.0 Index]