setTreestruct.TreeStructs: setTreestruct.TreeStructs

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

setTreestruct.TreeStructs

Description

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

Usage

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

Arguments

obj	TreeStructs object
treestructs	treestruct data frame
convert_to_meters	numeric. TreeQSM and treegraph use meters as a standard unit. If units are not in meters, pass the conversion factor here such that meters = QSMunits * convert_to_meters. Only radius and length values are converted, not cylinder positions or axes. A value of NA results in no conversion. Default: NA

Details

We use the column names defined in the object properties.

Value

TreeStructs 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.