multiDist: Metric function for 'multiPhylo' input

In treescape: Statistical Exploration of Landscapes of Phylogenetic Trees

Description

Comparison of a list of trees using the Kendall Colijn metric. Output is given as a pairwise distance matrix. This is equivalent to the $D output from treescape but may be preferable for large datasets, and when principal co-ordinate analysis is not required. It includes an option to save memory at the expense of computation time.

Usage

multiDist(trees, lambda = 0, return.lambda.function = FALSE,
  save.memory = FALSE, emphasise.tips = NULL, emphasise.weight = 2)

Arguments

trees	an object of the class multiPhylo containing the trees to be compared
lambda	a number in [0,1] which specifies the extent to which topology (default, with lambda=0) or branch lengths (lambda=1) are emphasised. This argument is ignored if return.lambda.function=TRUE.
return.lambda.function	If true, a function that can be invoked with different lambda values is returned. This function returns the matrix of metric values for the given lambda.
save.memory	A flag that saves a lot of memory but increases the execution time (not compatible with return.lambda.function=TRUE).
emphasise.tips	an optional list of tips whose entries in the tree vectors should be emphasised. Defaults to NULL.
emphasise.weight	applicable only if a list is supplied to emphasise.tips, this value (default 2) is the number by which vector entries corresponding to those tips are emphasised.

Value

The pairwise tree distance matrix or a function that produces the distance matrix given a value for lambda.

Author(s)

Jacob Almagro-Garcia [e-mail]

Michelle Kendall [e-mail]

Examples

## generate 10 random trees, each with 6 tips
trees <- rmtree(10,6)

## pairwise distance matrix when lambda=0
multiDist(trees)

## pairwise distance matrix as a function of lambda:
m <- multiDist(trees, return.lambda.function=TRUE)

## evaluate at lambda=0. Equivalent to multiDist(trees).
m0 <- m(0)

## save memory by recomputing each tree vector for each pairwise tree comparison (for fixed lambda):
m0.5 <- multiDist(trees,0.5,save.memory=TRUE)

treescape documentation built on May 19, 2017, 3:32 p.m.