setTreestruct.BranchStructs: setTreestruct.BranchStructs

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

setTreestruct.BranchStructs

Description

This validates and creates the nested dataframe and populates the object with it.

Usage

## S3 method for class 'BranchStructs'
setTreestruct(obj, treestructs, convert_to_meters = T, abort_when_invalid = F)

Arguments

obj	BranchStructs object
treestructs	treestruct data frame
convert_to_meters	Hand-measured branches typically use mm for diameter and cm for length. treestruct uses meters as a standard unit.

Details

We use the column names defined in the object properties. convert_to_meters is the amount to divide by to get meters. cm = 100, mm = 1000, etc.

Value

BranchStructs object with validated, nested, treestructs dataframe.

Examples

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

## End(Not run)

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