cati (version 0.99.3)

SumBL: Sum of branch length of a classification dendrogram (Petchey and Gaston, 2002)

Description

Sum of branch length of a classification dendrogram (Petchey and Gaston, 2002)

Usage

SumBL(traits, gower.dist = TRUE, method.hclust = "average", 
	scale.tr = TRUE, method.dist = "euclidian")

Arguments

traits

Traits matrix (traits in column)

gower.dist

Calculate gower distance using the function gowdis from package FD.

method.hclust

Define the method for the hclust function (default is "average" i.e. UPGMA).

scale.tr

Does traits need to be scale before multi-traits metric calculation? Only use when gower.dist = FALSE. Default is yes.

method.dist

Method to calculate the distance in case of multi-traits metric (function dist). Only use when gower.dist = FALSE. Default is euclidian.

Value

The value of the sum of branch length from a classification dendrogram of traits.

References

Petchey, OL., and Gaston, KJ. 2002. Functional diversity (FD), species richness and community composition. Ecology Letters 5:402-411

Examples

# NOT RUN {
# }
# NOT RUN {
data(finch.ind)
SumBL(traits.finch)
SumBL(traits.finch, gower.dist = FALSE)

# }
# NOT RUN {
# }