setGraph.BranchStructs: setGraph.BranchStructs

Description Usage Arguments Details Value Examples

View source: R/BranchStructs_methods.r

Description

FUNCTION_DESCRIPTION

Usage

1
2
## S3 method for class 'BranchStructs'
setGraph(obj, ts_accessor = getTreestruct)

Arguments

obj

BranchStructs object

Details

Invalid treestructs will have graph set to NA. This means that all functions making use of graphs will have to be able to handle NA as an input in addition to a graph object. This is a design decision. An alternative is to use an empty graph object, but then it becomes less obvious which treestructs are invalid and hence don't have graphs, and could lead to including erroneous data in analyses.

Value

OUTPUT_DESCRIPTION

Examples

1
2
3
4
5
6
## Not run: 
if(interactive()){
 #EXAMPLE1
 }

## End(Not run)

ashenkin/treestruct documentation built on Oct. 14, 2021, 1:54 a.m.