man/corBrownian.Rd

   1 \name{corBrownian}
   2 \alias{corBrownian}
   3 \alias{coef.corBrownian}
   4 \alias{corMatrix.corBrownian}
   5 \title{Brownian Correlation Structure}
   6 \usage{
   7         corBrownian(value=1, phy, form=~1)
   8         \method{coef}{corBrownian}(object, unconstrained = TRUE, ...)
   9         \method{corMatrix}{corBrownian}(object,
  10                         covariate = getCovariate(object), corr = TRUE, ...)
  11 }
  12 \arguments{
  13         \item{value}{The \eqn{\gamma}{gamma} parameter (default to 1)}
  14         \item{phy}{An object of class \code{phylo} representing the phylogeny
  15                 (with branch lengths) to consider}
  16         \item{object}{An (initialized) object of class \code{corBrownian}}
  17         \item{corr}{a logical value. If 'TRUE' the function returns the correlation matrix, otherwise it returns
  18                 the variance/covariance matrix.}
  19         \item{form}{ignored for now.}
  20         \item{covariate}{ignored for now.}
  21         \item{unconstrained}{a logical value. If 'TRUE' the coefficients are returned
  22     in unconstrained form (the same used in the optimization
  23     algorithm). If 'FALSE' the coefficients are returned in
  24     "natural", possibly constrained, form. Defaults to 'TRUE'}
  25         \item{\dots}{some methods for these generics require additional arguments.
  26                 None are used in these methods.}
  27 }
  28 \description{
  29         Expected covariance under a Brownian model (Felsenstein 1985, Martins and Hansen 1997):
  30                 \deqn{V_{ij} = \gamma \times t_a}{%
  31                                         Vij = gamma . ta}
  32         where \eqn{t_a}{ta} is the distance on the phylogeny between the root and the most recent common ancestor
  33         of taxa \eqn{i}{i} and \eqn{j}{j} and \eqn{\gamma}{gamma} is a constant.
  34 }
  35 \value{
  36         An object of class \code{corBrownian} or coefficient from an object of this class (actually sends \code{numeric(0)}!)
  37         or the correlation matrix of an initialized object of this class.
  38 }
  39 \author{Julien Dutheil \email{julien.dutheil@univ-montp2.fr}}
  40 \seealso{
  41   \code{\link{corClasses}}.
  42 }
  43 \references{
  44   Felsenstein, J. (1985) Phylogenies and the comparative method.
  45   \emph{American Naturalist}, \bold{125}, 1--15.
  46
  47   Martins, E. P. and Hansen, T. F. (1997) Phylogenies and the comparative
  48   method: a general approach to incorporating phylogenetic information
  49   into the analysis of interspecific data. \emph{American Naturalist},
  50   \bold{149}, 646--667.
  51 }
  52 \keyword{models}