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