getTreeLength.PhyloSim: Get the tree length from a PhyloSim object

Description Usage Arguments Value Author(s) See Also Examples

Description

Get the tree length from a PhyloSim object.

This method retruns the sum of the edge lengths stored in the aggregated phylo object.

Usage

1
2
## S3 method for class 'PhyloSim'
getTreeLength(this, ...)

Arguments

this

A PhyloSim object.

...

Not used.

Value

A numeric vector of length one.

Author(s)

Botond Sipos, Gregory Jordan

See Also

For more information see PhyloSim.

Examples

1
2
3
4
5
6
7
	# create a PhyloSim object
	sim<-PhyloSim(phylo=rcoal(5));
	# get the tree length
	getTreeLength(sim)
	# get tree length via virtual field
	sim$treeLength
 

phylosim documentation built on Nov. 22, 2019, 1:07 a.m.