cbl.moments: Computes the moments of the Common Branch Length measure...

Description Usage Arguments Value Author(s) References See Also Examples

View source: R/PhyloMeasures.R

Description

Calculates the mean and standard deviation of the Common Branch Length (CBL) on a given tree for several pairs of tip set sizes. These calculations consider equal (uniform) probability among all possible tip samples of the same richness.

Usage

1
2
cbl.moments(tree, sample.sizes, comp.expectation = TRUE, 
            comp.deviation = TRUE)

Arguments

tree

A phylo tree object

sample.sizes

A two-column matrix of non-negative integers indicating the tip set sizes for which the moments should be calculated. The moments are calculated for each row of the matrix. Let x and y be the values that are stored in the i-th row of sample.sizes. For this row, the CBL moments are calculated considering all pairs of tip sets that can be extracted from the input tree such that one set has x elements and the other set has y elements.

comp.expectation

Specifies whether the function computes the mean of the CBL (default = TRUE)

comp.deviation

Specifies whether the function computes the standard deviation of the CBL (default = TRUE)

Value

If both comp.expectation and comp.deviation are TRUE, the function returns a two-column matrix with one row per element in sample.sizes; the first column of the output matrix stores the mean CBL and the second column stores the standard deviation of this measure. If only one of comp.expectation or comp.deviation is TRUE, the function returns a vector with the corresponding values instead.

Author(s)

Constantinos Tsirogiannis (tsirogiannis.c@gmail.com)

References

Graham, C.H. and P.V.A. Fine. 2008. Phylogenetic beta diversity: linking ecological and evolutionary processes across space and time. Ecology Letters 11: 1265:1277.

Swenson, N.G. 2011. Phylogenetic beta diversity metrics, trait evolution and inferring functional beta diversity of communities. PLoS ONE: 6: e21264.

Tsirogiannis, C. and B. Sandel. In prep. Fast computation of measures of phylogenetic beta diversity.

See Also

cbl.query

Examples

1
2
3
4
#Load phylogenetic tree of bird families from package "ape"
data(bird.families, package = "ape")

cbl.moments(bird.families,sample.sizes = expand.grid(1:10,1:10))

PhyloMeasures documentation built on May 2, 2019, 6:17 a.m.