reorder_internodes.BranchStructs: reorder_internodes.BranchStructs

View source: R/BranchStructs_methods.r

reorder_internodes.BranchStructsR Documentation

reorder_internodes.BranchStructs

Description

reorders internodes in treestruct objects so pathlength and other accumulation routines work properly

Usage

## S3 method for class 'BranchStructs'
reorder_internodes(obj)

Arguments

obj

TreeStructs object

Details

This reorders all rows in the obj$treestructs$treestruct dataframes. It runs setTips if that hasn't already been run. This reorders rows such that, as you go down the dataframe, you can accumulate metrics (such as pathlength and surface area). That is, you are guaranteed that internodes above you (children, grandchildren, etc) will have been assigned values.

Value

TreeStructs object

Examples

## Not run: 
if(interactive()){
 #EXAMPLE1
 }

## End(Not run)

ashenkin/treestruct documentation built on June 11, 2025, 10:40 a.m.