R/ace.R

   1 ## ace.R (2010-05-12)
   2
   3 ##   Ancestral Character Estimation
   4
   5 ## Copyright 2005-2010 Emmanuel Paradis and Ben Bolker
   6
   7 ## This file is part of the R-package `ape'.
   8 ## See the file ../COPYING for licensing issues.
   9
  10 ace <- function(x, phy, type = "continuous", method = "ML", CI = TRUE,
  11                 model = if (type == "continuous") "BM" else "ER",
  12                 scaled = TRUE, kappa = 1, corStruct = NULL, ip = 0.1)
  13 {
  14     if (!inherits(phy, "phylo"))
  15         stop('object "phy" is not of class "phylo".')
  16     if (is.null(phy$edge.length))
  17         stop("tree has no branch lengths")
  18     type <- match.arg(type, c("continuous", "discrete"))
  19     nb.tip <- length(phy$tip.label)
  20     nb.node <- phy$Nnode
  21     if (nb.node != nb.tip - 1)
  22       stop('"phy" is not rooted AND fully dichotomous.')
  23     if (length(x) != nb.tip)
  24       stop("length of phenotypic and of phylogenetic data do not match.")
  25     if (!is.null(names(x))) {
  26         if(all(names(x) %in% phy$tip.label))
  27           x <- x[phy$tip.label]
  28         else warning("the names of 'x' and the tip labels of the tree do not match: the former were ignored in the analysis.")
  29     }
  30     obj <- list()
  31     if (kappa != 1) phy$edge.length <- phy$edge.length^kappa
  32     if (type == "continuous") {
  33         if (method == "pic") {
  34             if (model != "BM")
  35               stop('the "pic" method can be used only with model = "BM".')
  36             ## See pic.R for some annotations.
  37             phy <- reorder(phy, "pruningwise")
  38             phenotype <- numeric(nb.tip + nb.node)
  39             phenotype[1:nb.tip] <- if (is.null(names(x))) x else x[phy$tip.label]
  40             contr <- var.con <- numeric(nb.node)
  41             ans <- .C("pic", as.integer(nb.tip), as.integer(nb.node),
  42                       as.integer(phy$edge[, 1]), as.integer(phy$edge[, 2]),
  43                       as.double(phy$edge.length), as.double(phenotype),
  44                       as.double(contr), as.double(var.con),
  45                       as.integer(CI), as.integer(scaled),
  46                       PACKAGE = "ape")
  47             obj$ace <- ans[[6]][-(1:nb.tip)]
  48             names(obj$ace) <- (nb.tip + 1):(nb.tip + nb.node)
  49             if (CI) {
  50                 se <- sqrt(ans[[8]])
  51                 CI95 <- matrix(NA, nb.node, 2)
  52                 CI95[, 1] <- obj$ace + se * qnorm(0.025)
  53                 CI95[, 2] <- obj$ace - se * qnorm(0.025)
  54                 obj$CI95 <- CI95
  55             }
  56         }
  57         if (method == "ML") {
  58             if (model == "BM") {
  59                 tip <- phy$edge[, 2] <= nb.tip
  60                 dev.BM <- function(p) {
  61                     if (p[1] < 0) return(1e100) # in case sigma² is negative
  62                     x1 <- p[-1][phy$edge[, 1] - nb.tip]
  63                     x2 <- numeric(length(x1))
  64                     x2[tip] <- x[phy$edge[tip, 2]]
  65                     x2[!tip] <- p[-1][phy$edge[!tip, 2] - nb.tip]
  66                     -2 * (-sum((x1 - x2)^2/phy$edge.length)/(2*p[1]) -
  67                           nb.node * log(p[1]))
  68                 }
  69                 out <- nlm(function(p) dev.BM(p),
  70                            p = c(1, rep(mean(x), nb.node)), hessian = TRUE)
  71                 obj$loglik <- -out$minimum / 2
  72                 obj$ace <- out$estimate[-1]
  73                 names(obj$ace) <- (nb.tip + 1):(nb.tip + nb.node)
  74                 se <- sqrt(diag(solve(out$hessian)))
  75                 obj$sigma2 <- c(out$estimate[1], se[1])
  76                 se <- se[-1]
  77                 if (CI) {
  78                     CI95 <- matrix(NA, nb.node, 2)
  79                     CI95[, 1] <- obj$ace + se * qt(0.025, nb.node)
  80                     CI95[, 2] <- obj$ace - se * qt(0.025, nb.node)
  81                     obj$CI95 <- CI95
  82                 }
  83             }
  84         }
  85         if (method == "GLS") {
  86             if (is.null(corStruct))
  87               stop('you must give a correlation structure if method = "GLS".')
  88             if (class(corStruct)[1] == "corMartins")
  89               M <- corStruct[1] * dist.nodes(phy)
  90             if (class(corStruct)[1] == "corGrafen")
  91               phy <- compute.brlen(attr(corStruct, "tree"),
  92                                    method = "Grafen",
  93                                    power = exp(corStruct[1]))
  94             if (class(corStruct)[1] %in% c("corBrownian", "corGrafen")) {
  95                 dis <- dist.nodes(attr(corStruct, "tree"))
  96                 MRCA <- mrca(attr(corStruct, "tree"), full = TRUE)
  97                 M <- dis[as.character(nb.tip + 1), MRCA]
  98                 dim(M) <- rep(sqrt(length(M)), 2)
  99             }
 100             varAY <- M[-(1:nb.tip), 1:nb.tip]
 101             varA <- M[-(1:nb.tip), -(1:nb.tip)]
 102             V <- corMatrix(Initialize(corStruct, data.frame(x)),
 103                            corr = FALSE)
 104             invV <- solve(V)
 105             o <- gls(x ~ 1, data.frame(x), correlation = corStruct)
 106             GM <- o$coefficients
 107             obj$ace <- drop(varAY %*% invV %*% (x - GM) + GM)
 108             names(obj$ace) <- (nb.tip + 1):(nb.tip + nb.node)
 109             if (CI) {
 110                 CI95 <- matrix(NA, nb.node, 2)
 111                 se <- sqrt((varA - varAY %*% invV %*% t(varAY))[cbind(1:nb.node, 1:nb.node)])
 112                 CI95[, 1] <- obj$ace + se * qnorm(0.025)
 113                 CI95[, 2] <- obj$ace - se * qnorm(0.025)
 114                 obj$CI95 <- CI95
 115             }
 116         }
 117     } else { # type == "discrete"
 118         if (method != "ML")
 119           stop("only ML estimation is possible for discrete characters.")
 120         if (!is.factor(x)) x <- factor(x)
 121         nl <- nlevels(x)
 122         lvls <- levels(x)
 123         x <- as.integer(x)
 124         if (is.character(model)) {
 125             rate <- matrix(NA, nl, nl)
 126             if (model == "ER") np <- rate[] <- 1
 127             if (model == "ARD") {
 128                 np <- nl*(nl - 1)
 129                 rate[col(rate) != row(rate)] <- 1:np
 130             }
 131             if (model == "SYM") {
 132                 np <- nl * (nl - 1)/2
 133                 sel <- col(rate) < row(rate)
 134                 rate[sel] <- 1:np
 135                 rate <- t(rate)
 136                 rate[sel] <- 1:np
 137             }
 138         } else {
 139             if (ncol(model) != nrow(model))
 140               stop("the matrix given as `model' is not square")
 141             if (ncol(model) != nl)
 142               stop("the matrix `model' must have as many rows
 143 as the number of categories in `x'")
 144             rate <- model
 145             np <- max(rate)
 146         }
 147         index.matrix <- rate
 148         tmp <- cbind(1:nl, 1:nl)
 149         index.matrix[tmp] <- NA
 150         rate[tmp] <- 0
 151         rate[rate == 0] <- np + 1 # to avoid 0's since we will use this as numeric indexing
 152
 153         liks <- matrix(0, nb.tip + nb.node, nl)
 154         TIPS <- 1:nb.tip
 155         liks[cbind(TIPS, x)] <- 1
 156         phy <- reorder(phy, "pruningwise")
 157
 158         Q <- matrix(0, nl, nl)
 159         dev <- function(p, output.liks = FALSE) {
 160             if (any(is.nan(p)) || any(is.infinite(p))) return(1e50)
 161             ## from Rich FitzJohn:
 162             comp <- numeric(nb.tip + nb.node) # Storage...
 163             Q[] <- c(p, 0)[rate]
 164             diag(Q) <- -rowSums(Q)
 165             for (i  in seq(from = 1, by = 2, length.out = nb.node)) {
 166                 j <- i + 1L
 167                 anc <- phy$edge[i, 1]
 168                 des1 <- phy$edge[i, 2]
 169                 des2 <- phy$edge[j, 2]
 170                 v.l <- matexpo(Q * phy$edge.length[i]) %*% liks[des1, ]
 171                 v.r <- matexpo(Q * phy$edge.length[j]) %*% liks[des2, ]
 172                 v <- v.l * v.r
 173                 comp[anc] <- sum(v)
 174                 liks[anc, ] <- v/comp[anc]
 175             }
 176             if (output.liks) return(liks[-TIPS, ])
 177             -2 * sum(log(comp[-TIPS]))
 178         }
 179         out <- nlminb(rep(ip, length.out = np), function(p) dev(p),
 180                       lower = rep(0, np), upper = rep(1e50, np))
 181         obj$loglik <- -out$objective/2
 182         obj$rates <- out$par
 183         oldwarn <- options("warn")
 184         options(warn = -1)
 185         h <- nlm(function(p) dev(p), p = obj$rates, iterlim = 1,
 186                  stepmax = 0, hessian = TRUE)$hessian
 187         options(oldwarn)
 188         if (any(h == 0))
 189           warning("The likelihood gradient seems flat in at least one dimension (gradient null):\ncannot compute the standard-errors of the transition rates.\n")
 190         else obj$se <- sqrt(diag(solve(h)))
 191         obj$index.matrix <- index.matrix
 192         if (CI) {
 193             obj$lik.anc <- dev(obj$rates, TRUE)
 194             colnames(obj$lik.anc) <- lvls
 195         }
 196     }
 197     obj$call <- match.call()
 198     class(obj) <- "ace"
 199     obj
 200 }
 201
 202 logLik.ace <- function(object, ...) object$loglik
 203
 204 deviance.ace <- function(object, ...) -2*object$loglik
 205
 206 AIC.ace <- function(object, ..., k = 2)
 207 {
 208     if (is.null(object$loglik)) return(NULL)
 209     ## Trivial test of "type"; may need to be improved
 210     ## if other models are included in ace(type = "c")
 211     np <- if (!is.null(object$sigma2)) 1 else length(object$rates)
 212     -2*object$loglik + np*k
 213 }
 214
 215 ### by BB:
 216 anova.ace <- function(object, ...)
 217 {
 218     X <- c(list(object), list(...))
 219     df <- sapply(lapply(X, "[[", "rates"), length)
 220     ll <- sapply(X, "[[", "loglik")
 221     ## check if models are in correct order?
 222     dev <- c(NA, 2*diff(ll))
 223     ddf <- c(NA, diff(df))
 224     table <- data.frame(ll, df, ddf, dev,
 225                         pchisq(dev, ddf, lower.tail = FALSE))
 226     dimnames(table) <- list(1:length(X), c("Log lik.", "Df",
 227                                            "Df change", "Resid. Dev",
 228                                            "Pr(>|Chi|)"))
 229     structure(table, heading = "Likelihood Ratio Test Table",
 230               class = c("anova", "data.frame"))
 231 }
 232
 233 print.ace <- function(x, digits = 4, ...)
 234 {
 235     cat("\n    Ancestral Character Estimation\n\n")
 236     cat("Call: ")
 237     print(x$call)
 238     cat("\n")
 239     if (!is.null(x$loglik))
 240         cat("    Log-likelihood:", x$loglik, "\n\n")
 241     ratemat <- x$index.matrix
 242     if (is.null(ratemat)) { # to be improved
 243         class(x) <- NULL
 244         x$loglik <- x$call <- NULL
 245         print(x)
 246     } else {
 247         dimnames(ratemat)[1:2] <- dimnames(x$lik.anc)[2]
 248         cat("Rate index matrix:\n")
 249         print(ratemat, na.print = ".")
 250         cat("\n")
 251         npar <- length(x$rates)
 252         estim <- data.frame(1:npar, round(x$rates, digits), round(x$se, digits))
 253         cat("Parameter estimates:\n")
 254         names(estim) <- c("rate index", "estimate", "std-err")
 255         print(estim, row.names = FALSE)
 256         cat("\nScaled likelihoods at the root (type 'x$lik.anc' to get them for all nodes):\n")
 257         print(x$lik.anc[1, ])
 258     }
 259 }