findSibling: find the sibling node

Description Usage Arguments Value Examples

View source: R/tree_findSibling.R

Description

findSibling is to find the sibling node of an node node.

Usage

1
findSibling(tree, node, use.alias = FALSE)

Arguments

tree

A phylo object.

node

A numeric or character vector. Node labels or node numbers.

use.alias

A logical value, TRUE or FALSE. The default is FALSE, and the original node label would be used to name the output; otherwise, the alias of node label would be used to name the output. The alias of node label is created by adding a prefix "alias_" to the node number.

Value

A vector of nodes. The numeric value is the node number, and the vector name is the corresponding node label. If a node has no label, it would have NA as name when use.alias = FALSE, and have the alias of node label as name when use.alias = TRUE.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
library(ggtree)
data(tinyTree)
ggtree(tinyTree, branch.length = 'none') +
    geom_text2(aes(label = label), color = "darkorange",
           hjust = -0.1, vjust = -0.7) +
    geom_text2(aes(label = node), color = "darkblue",
               hjust = -0.5, vjust = 0.7)


 findSibling(tree = tinyTree, node = 17)
 findSibling(tree = tinyTree, node = c(13, 17))

fionarhuang/TreeSummarizedExperiment documentation built on June 16, 2021, 2:11 p.m.