BranchStructs: BranchStructs

In ashenkin/treestruct: Provides Classes for Analysis and Manipulation of Tree Structure Models

BranchStructs

Description

BranchStructs are hand-measured branches or trees. This is a constructor for the BranchStructs S3 object. Set column names before importing the treestruct dataframe

Usage

BranchStructs(
  dataset = NA,
  treestructs,
  convert_to_meters = NA,
  has_topology = T
)

Arguments

dataset	name of dataset this object is based on
treestructs	dataframe of architecture data. required.
surface_area_total	total surface area of branch
pathlen_total	total pathlength of branch (sum of branch lengths)
idcol	name of branch id column; default = "branch_code"
datecol	name of date column; default = "date"
internodeid_col	name internode id column; default = "internode_id"
parentid_col	name of parent internode id column; default = "parent_id"
furcation_col	name of furcation number column; default = "n_furcation"
length_col	name of internode length column; default = "len"
angle_col	name of angle column; default = "major_child_angle"
angle_internode1_col	name of angle internode 1 column; default = "angle_internode_1"
angle_internode2_col	name of angle internode 2 column; default = "angle_internode_2"
numnodes_col	name of number of nodes in section column; default = "number_nodes_in_section"
istip_col	name of is tip column; default = "is_tip"
isbroken_col	name of is broken column; default = "is_broken"
d_child_col	name of internode diameter @ child (top) column; default = "d_child"
d_parent_col	name of internode diameter @ parent (base) column; default = "d_parent"

Details

To create a branchstruct, pass a dataset with the following columns (unless you specify different column names, which is not recommended): branch_code date internode_id parent_id n_furcation (optional) len major_child_angle (optional) angle_internode_1 (optional) angle_internode_2 (optional) number_nodes_in_section (optional) is_tip is_broken d_child d_parent

Value

OUTPUT_DESCRIPTION

Examples

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

## End(Not run)

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