File: vcv.phylo.Rd

package info (click to toggle)
r-cran-ape 5.7-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,932 kB
  • sloc: ansic: 7,626; cpp: 116; sh: 17; makefile: 2
file content (56 lines) | stat: -rw-r--r-- 1,840 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
\name{vcv}
\alias{vcv}
\alias{vcv.phylo}
\alias{vcv.corPhyl}
\title{Phylogenetic Variance-covariance or Correlation Matrix}
\usage{
vcv(phy, ...)
\method{vcv}{phylo}(phy, model = "Brownian", corr = FALSE, ...)
\method{vcv}{corPhyl}(phy, corr = FALSE, ...)
}
\arguments{
  \item{phy}{an object of the correct class (see above).}
  \item{model}{a character giving the model used to compute the
    variances and covariances; only \code{"Brownian"} is available (for
    other models, a correlation structure may be used).}
  \item{corr}{a logical indicating whether the correlation matrix should
    be returned (\code{TRUE}); by default the variance-covariance matrix
    is returned (\code{FALSE}).}
  \item{\dots}{further arguments to be passed to or from other methods.}
}
\description{
  This function computes the expected variances and covariances of a
  continuous trait assuming it evolves under a given model.

  This is a generic function with methods for objects of class
  \code{"phylo"} and \code{"corPhyl"}.
}
\value{
  a numeric matrix with the names of the tips as colnames and rownames.
}
\references{
  Garland, T. Jr. and Ives, A. R. (2000) Using the past to predict the
  present: confidence intervals for regression equations in phylogenetic
  comparative methods. \emph{American Naturalist}, \bold{155}, 346--364.
}

\author{Emmanuel Paradis}
\note{
  Do not confuse this function with \code{\link[stats]{vcov}} which
  computes the variance-covariance matrix among parameters of a fitted
  model object.
}
\seealso{
  \code{\link{corBrownian}}, \code{\link{corMartins}},
  \code{\link{corGrafen}}, \code{\link{corPagel}},
  \code{\link{corBlomberg}}, \code{\link{vcv2phylo}}
}
\examples{
tr <- rtree(5)
## all are the same:
vcv(tr)
vcv(corBrownian(1, tr))
vcv(corPagel(1, tr))
}
\keyword{manip}
\keyword{multivariate}