R/dist.topo.R

   1 ## dist.topo.R (2010-01-25)
   2
   3 ##      Topological Distances, Tree Bipartitions,
   4 ##   Consensus Trees, and Bootstrapping Phylogenies
   5
   6 ## Copyright 2005-2010 Emmanuel Paradis
   7
   8 ## This file is part of the R-package `ape'.
   9 ## See the file ../COPYING for licensing issues.
  10
  11 dist.topo <- function(x, y, method = "PH85")
  12 {
  13     if (method == "score" && (is.null(x$edge.length) || is.null(y$edge.length)))
  14         stop("trees must have branch lengths for Billera et al.'s distance.")
  15     nx <- length(x$tip.label)
  16     x <- unroot(x)
  17     y <- unroot(y)
  18     bp1 <- .Call("bipartition", x$edge, nx, x$Nnode, PACKAGE = "ape")
  19     bp1 <- lapply(bp1, function(xx) sort(x$tip.label[xx]))
  20     ny <- length(y$tip.label) # fix by Otto Cordero
  21     ## fix by Tim Wallstrom:
  22     bp2.tmp <- .Call("bipartition", y$edge, ny, y$Nnode, PACKAGE = "ape")
  23     bp2 <- lapply(bp2.tmp, function(xx) sort(y$tip.label[xx]))
  24     bp2.comp <- lapply(bp2.tmp, function(xx) setdiff(1:ny, xx))
  25     bp2.comp <- lapply(bp2.comp, function(xx) sort(y$tip.label[xx]))
  26     ## End
  27     q1 <- length(bp1)
  28     q2 <- length(bp2)
  29     if (method == "PH85") {
  30         p <- 0
  31         for (i in 1:q1) {
  32             for (j in 1:q2) {
  33                 if (identical(bp1[[i]], bp2[[j]]) | identical(bp1[[i]], bp2.comp[[j]])) {
  34                     p <- p + 1
  35                     break
  36                 }
  37             }
  38         }
  39         dT <- q1 + q2 - 2 * p # same than:
  40         ##dT <- if (q1 == q2) 2*(q1 - p) else 2*(min(q1, q2) - p) + abs(q1 - q2)
  41     }
  42     if (method == "score") {
  43         dT <- 0
  44         found1 <- FALSE
  45         found2 <- logical(q2)
  46         found2[1] <- TRUE
  47         for (i in 2:q1) {
  48             for (j in 2:q2) {
  49                 if (identical(bp1[[i]], bp2[[j]]) | identical(bp1[[i]], bp2.comp[[j]])) {
  50                     if (i == 19) browser()
  51                     dT <- dT + (x$edge.length[which(x$edge[, 2] == nx + i)] -
  52                                 y$edge.length[which(y$edge[, 2] == ny + j)])^2
  53                     found1 <- found2[j] <- TRUE
  54                     break
  55                 }
  56             }
  57             if (found1) found1 <- FALSE
  58             else dT <- dT + (x$edge.length[which(x$edge[, 2] == nx + i)])^2
  59         }
  60         if (!all(found2))
  61             dT <- dT + sum((y$edge.length[y$edge[, 2] %in% (ny + which(!found2))])^2)
  62         dT <- sqrt(dT)
  63     }
  64     dT
  65 }
  66
  67 .compressTipLabel <- function(x)
  68 {
  69     ## 'x' is a list of objects of class "phylo" possibly with no class
  70     if (!is.null(attr(x, "TipLabel"))) return(x)
  71     ref <- x[[1]]$tip.label
  72     if (any(table(ref) != 1))
  73         stop("some tip labels are duplicated in tree no. 1")
  74     n <- length(ref)
  75     for (i in 2:length(x)) {
  76         if (identical(x[[i]]$tip.label, ref)) next
  77         ilab <- match(x[[i]]$tip.label, ref)
  78         ## can use tabulate here because 'ilab' contains integers
  79         if (any(tabulate(ilab) > 1))
  80             stop(paste("some tip labels are duplicated in tree no.", i))
  81         if (any(is.na(ilab)))
  82             stop(paste("tree no.", i, "has different tip labels"))
  83         ie <- match(1:n, x[[i]]$edge[, 2])
  84         x[[i]]$edge[ie, 2] <- ilab
  85         x[[i]]$tip.label <- NULL
  86     }
  87     x[[1]]$tip.label <- NULL
  88     attr(x, "TipLabel") <- ref
  89     x
  90 }
  91
  92 prop.part <- function(..., check.labels = TRUE)
  93 {
  94     obj <- list(...)
  95     if (length(obj) == 1 && class(obj[[1]]) != "phylo")
  96         obj <- obj[[1]]
  97     ## <FIXME>
  98     ## class(obj) <- NULL # needed?
  99     ## </FIXME>
 100     ntree <- length(obj)
 101     if (ntree == 1) check.labels <- FALSE
 102     if (check.labels) obj <- .compressTipLabel(obj)
 103     for (i in 1:ntree) storage.mode(obj[[i]]$Nnode) <- "integer"
 104     ## <FIXME>
 105     ## The 1st must have tip labels
 106     ## Maybe simply pass the number of tips to the C code??
 107     if (!is.null(attr(obj, "TipLabel")))
 108         for (i in 1:ntree) obj[[i]]$tip.label <- attr(obj, "TipLabel")
 109     ## </FIXME>
 110     clades <- .Call("prop_part", obj, ntree, TRUE, PACKAGE = "ape")
 111     attr(clades, "number") <- attr(clades, "number")[1:length(clades)]
 112     attr(clades, "labels") <- obj[[1]]$tip.label
 113     class(clades) <- "prop.part"
 114     clades
 115 }
 116
 117 print.prop.part <- function(x, ...)
 118 {
 119     if (is.null(attr(x, "labels"))) {
 120         for (i in 1:length(x)) {
 121             cat("==>", attr(x, "number")[i], "time(s):")
 122             print(x[[i]], quote = FALSE)
 123         }
 124     } else {
 125         for (i in 1:length(attr(x, "labels")))
 126           cat(i, ": ", attr(x, "labels")[i], "\n", sep = "")
 127         cat("\n")
 128         for (i in 1:length(x)) {
 129             cat("==>", attr(x, "number")[i], "time(s):")
 130             print(x[[i]], quote = FALSE)
 131         }
 132     }
 133 }
 134
 135 summary.prop.part <- function(object, ...) attr(object, "number")
 136
 137 plot.prop.part <- function(x, barcol = "blue", leftmar = 4, ...)
 138 {
 139     if (is.null(attr(x, "labels")))
 140       stop("cannot plot this partition object; see ?prop.part for details.")
 141     L <- length(x)
 142     n <- length(attr(x, "labels"))
 143     layout(matrix(1:2, 2, 1), heights = c(1, 3))
 144     par(mar = c(0.1, leftmar, 0.1, 0.1))
 145     plot(1:L, attr(x, "number"), type = "h", col = barcol, xlim = c(1, L),
 146          xlab = "", ylab = "Frequency", xaxt = "n", bty = "n")
 147     plot(0, type = "n", xlim = c(1, L), ylim = c(1, n),
 148          xlab = "", ylab = "", xaxt = "n", yaxt = "n")
 149     for (i in 1:L) points(rep(i, length(x[[i]])), x[[i]], ...)
 150     mtext(attr(x, "labels"), side = 2, at = 1:n, las = 1)
 151 }
 152
 153 prop.clades <- function(phy, ..., part = NULL)
 154 {
 155     if (is.null(part)) {
 156         obj <- list(...)
 157         if (length(obj) == 1 && class(obj[[1]]) != "phylo")
 158           obj <- unlist(obj, recursive = FALSE)
 159         part <- prop.part(obj, check.labels = TRUE)
 160     }
 161     bp <- .Call("bipartition", phy$edge, length(phy$tip.label),
 162                 phy$Nnode, PACKAGE = "ape")
 163     if (!is.null(attr(part, "labels")))
 164       for (i in 1:length(part))
 165         part[[i]] <- sort(attr(part, "labels")[part[[i]]])
 166     bp <- lapply(bp, function(xx) sort(phy$tip.label[xx]))
 167     n <- numeric(phy$Nnode)
 168     for (i in 1:phy$Nnode) {
 169         for (j in 1:length(part)) {
 170             if (identical(all.equal(bp[[i]], part[[j]]), TRUE)) {
 171                 n[i] <- attr(part, "number")[j]
 172                 done <-  TRUE
 173                 break
 174             }
 175         }
 176     }
 177     n
 178 }
 179
 180 boot.phylo <- function(phy, x, FUN, B = 100, block = 1, trees = FALSE)
 181 {
 182     if (is.list(x) && !is.data.frame(x)) {
 183         if (inherits(x, "DNAbin")) x <- as.matrix(x)
 184         else {
 185             nm <- names(x)
 186             n <- length(x)
 187             x <- unlist(x)
 188             nL <- length(x)
 189             x <- matrix(x, n, nL/n, byrow = TRUE)
 190             rownames(x) <- nm
 191         }
 192     }
 193     boot.tree <- vector("list", B)
 194     for (i in 1:B) {
 195         if (block > 1) {
 196             y <- seq(block, ncol(x), block)
 197             boot.i <- sample(y, replace = TRUE)
 198             boot.samp <- numeric(ncol(x))
 199             boot.samp[y] <- boot.i
 200             for (j in 1:(block - 1))
 201               boot.samp[y - j] <- boot.i - j
 202         } else boot.samp <- sample(ncol(x), replace = TRUE)
 203         boot.tree[[i]] <- FUN(x[, boot.samp])
 204     }
 205     for (i in 1:B) storage.mode(boot.tree[[i]]$Nnode) <- "integer"
 206     storage.mode(phy$Nnode) <- "integer"
 207     ans <- attr(.Call("prop_part", c(list(phy), boot.tree),
 208                       B + 1, FALSE, PACKAGE = "ape"), "number") - 1
 209     if (trees) ans <- list(BP = ans, trees = boot.tree)
 210     ans
 211 }
 212
 213 consensus <- function(..., p = 1, check.labels = TRUE)
 214 {
 215     foo <- function(ic, node) {
 216         ## ic: index of 'pp'
 217         ## node: node number in the final tree
 218         pool <- pp[[ic]]
 219         if (ic < m) {
 220             for (j in (ic + 1):m) {
 221                 wh <- match(pp[[j]], pool)
 222                 if (!any(is.na(wh))) {
 223                     edge[pos, 1] <<- node
 224                     pool <- pool[-wh]
 225                     edge[pos, 2] <<- nextnode <<- nextnode + 1L
 226                     pos <<- pos + 1L
 227                     foo(j, nextnode)
 228                 }
 229             }
 230         }
 231         size <- length(pool)
 232         if (size) {
 233             ind <- pos:(pos + size - 1)
 234             edge[ind, 1] <<- node
 235             edge[ind, 2] <<- pool
 236             pos <<- pos + size
 237         }
 238     }
 239     obj <- list(...)
 240     if (length(obj) == 1) {
 241         ## better than unlist(obj, recursive = FALSE)
 242         ## because "[[" keeps the class of 'obj':
 243         obj <- obj[[1]]
 244         if (class(obj) == "phylo") return(obj)
 245     }
 246     if (!is.null(attr(obj, "TipLabel")))
 247         labels <- attr(obj, "TipLabel")
 248     else {
 249         labels <- obj[[1]]$tip.label
 250         if (check.labels) obj <- .compressTipLabel(obj)
 251     }
 252     ntree <- length(obj)
 253     ## Get all observed partitions and their frequencies:
 254     pp <- prop.part(obj, check.labels = FALSE)
 255     ## Drop the partitions whose frequency is less than 'p':
 256     pp <- pp[attr(pp, "number") >= p * ntree]
 257     ## Get the order of the remaining partitions by decreasing size:
 258     ind <- sort(unlist(lapply(pp, length)), decreasing = TRUE,
 259                 index.return = TRUE)$ix
 260     pp <- pp[ind]
 261     n <- length(labels)
 262     m <- length(pp)
 263     edge <- matrix(0L, n + m - 1, 2)
 264     if (m == 1) {
 265         edge[, 1] <- n + 1L
 266         edge[, 2] <- 1:n
 267     } else {
 268         nextnode <- n + 1L
 269         pos <- 1L
 270         foo(1, nextnode)
 271     }
 272     structure(list(edge = edge, tip.label = labels,
 273               Nnode = m), class = "phylo")
 274 }