dot-findOS: Find descendants (or offsprings)

In fionarhuang/TreeHeatmap: A package to plot heatmaps at different levels of a tree

Find descendants (or offsprings)

Description

.findOS finds descendants of a node.

Usage

.findOS(tree, node, only.leaf = TRUE, self.include = FALSE, use.alias = FALSE)

Arguments

tree	A phylo object.
node	An internal node. It could be the node number or the node label.
only.leaf	A logical value, TRUE or FALSE. The default is TRUE. If default, only the leaf nodes in the descendant nodes would be returned.
self.include	A logical value, TRUE or FALSE. The default is FALSE. If TRUE, the node specified in node is included and the leaf node itself is returned as its descendant.
use.alias	A logical value, TRUE or FALSE. The default is FALSE, and the 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.

Author(s)

Ruizhu Huang

fionarhuang/TreeHeatmap documentation built on Feb. 1, 2024, 7:30 a.m.