]> git.donarmstrong.com Git - ape.git/blob - man/vcv.phylo.Rd
various bug fixes
[ape.git] / man / vcv.phylo.Rd
1 \name{vcv}
2 \alias{vcv}
3 \alias{vcv.phylo}
4 \alias{vcv.corPhyl}
5 \title{Phylogenetic Variance-covariance or Correlation Matrix}
6 \usage{
7 vcv(phy, ...)
8 \method{vcv}{phylo}(phy, model = "Brownian", corr = FALSE, ...)
9 \method{vcv}{corPhyl}(phy, corr = FALSE, ...)
10 }
11 \arguments{
12   \item{phy}{an object of the correct class (see above).}
13   \item{model}{a character giving the model used to compute the
14     variances and covariances; only \code{"Brownian"} is available.}
15   \item{corr}{a logical indicating whether the correlation matrix should
16     be returned (\code{TRUE}); by default the variance-covariance matrix
17     is returned (\code{FALSE}).}
18   \item{\dots}{further arguments to be passed to or from other methods.}
19 }
20 \description{
21   This function computes the expected variances and covariances of a
22   continuous trait assuming it evolves under a given model.
23
24   This is a generic function with methods for objects of class
25   \code{"phylo"} and \code{"corPhyl"}.
26 }
27 \value{
28   a numeric matrix with the names of the tips as colnames and rownames.
29 }
30 \references{
31   Garland, T. Jr. and Ives, A. R. (2000) Using the past to predict the
32   present: confidence intervals for regression equations in phylogenetic
33   comparative methods. \emph{American Naturalist}, \bold{155}, 346--364.
34 }
35
36 \author{Emmanuel Paradis}
37 \note{
38   Do not confuse this function with \code{\link[stats]{vcov}} which
39   computes the variance-covariance matrix among parameters of a fitted
40   model object.
41 }
42 \seealso{
43   \code{\link{corBrownian}}, \code{\link{corMartins}},
44   \code{\link{corGrafen}}, \code{\link{corPagel}},
45   \code{\link{corBlomberg}}
46 }
47 \examples{
48 tr <- rtree(5)
49 ## all are the same:
50 vcv(tr)
51 vcv(corBrownian(1, tr))
52 vcv(corPagel(1, tr))
53 }
54 \keyword{manip}
55 \keyword{multivariate}