R/drop.tip.R

   1 ## drop.tip.R (2010-02-11)
   2
   3 ##   Remove Tips in a Phylogenetic Tree
   4
   5 ## Copyright 2003-2010 Emmanuel Paradis
   6
   7 ## This file is part of the R-package `ape'.
   8 ## See the file ../COPYING for licensing issues.
   9
  10 extract.clade <- function(phy, node, root.edge = 0, interactive = FALSE)
  11 {
  12     Ntip <- length(phy$tip.label)
  13     ROOT <- Ntip + 1
  14     Nedge <- dim(phy$edge)[1]
  15     wbl <- !is.null(phy$edge.length)
  16     if (interactive) node <- identify(phy)$nodes else {
  17         if (length(node) > 1) {
  18             node <- node[1]
  19             warning("only the first value of 'node' has been considered")
  20         }
  21         if (is.character(node)) {
  22             if (is.null(phy$node.label))
  23                 stop("the tree has no node labels")
  24             node <- which(phy$node.label %in% node) + Ntip
  25         }
  26         if (node <= Ntip)
  27             stop("node number must be greater than the number of tips")
  28     }
  29     if (node == ROOT) return(phy)
  30     phy <- reorder(phy) # insure it is in cladewise order
  31     root.node <- which(phy$edge[, 2] == node)
  32     start <- root.node + 1 # start of the clade looked for
  33     anc <- phy$edge[root.node, 1] # the ancestor of 'node'
  34     next.anc <- which(phy$edge[-(1:start), 1] <= anc) # find the next occurence of 'anc' or an 'older' node
  35
  36     keep <- if (length(next.anc)) start + 0:(next.anc[1] - 1) else start:Nedge
  37
  38     if (root.edge) {
  39         NewRootEdge <- phy$edge.length[root.node]
  40         root.edge <- root.edge - 1
  41         while (root.edge) {
  42             if (anc == ROOT) break
  43             i <- which(phy$edge[, 2] ==  anc)
  44             NewRootEdge <- NewRootEdge + phy$edge.length[i]
  45             root.edge <- root.edge - 1
  46             anc <- phy$edge[i, 1]
  47         }
  48         if (root.edge && !is.null(phy$root.edge))
  49             NewRootEdge <- NewRootEdge + phy$root.edge
  50         phy$root.edge <- NewRootEdge
  51     }
  52
  53     phy$edge <- phy$edge[keep, ]
  54     if (wbl) phy$edge.length <- phy$edge.length[keep]
  55     TIPS <- phy$edge[, 2] <= Ntip
  56     tip <- phy$edge[TIPS, 2]
  57     phy$tip.label <- phy$tip.label[tip]
  58     ## keep the ordering so no need to reorder tip.label:
  59     phy$edge[TIPS, 2] <- order(tip)
  60     if (!is.null(phy$node.label))
  61         phy$node.label <- phy$node.label[sort(unique(phy$edge[, 1])) - Ntip]
  62     Ntip <- length(phy$tip.label)
  63     phy$Nnode <- dim(phy$edge)[1] - Ntip + 1L
  64     ## The block below renumbers the nodes so that they conform
  65     ## to the "phylo" format -- same as in root()
  66     newNb <- integer(Ntip + phy$Nnode)
  67     newNb[node] <- Ntip + 1L
  68     sndcol <- phy$edge[, 2] > Ntip
  69     ## executed from right to left, so newNb is modified before phy$edge:
  70     phy$edge[sndcol, 2] <- newNb[phy$edge[sndcol, 2]] <-
  71         (Ntip + 2):(Ntip + phy$Nnode)
  72     phy$edge[, 1] <- newNb[phy$edge[, 1]]
  73     phy
  74 }
  75
  76 drop.tip <-
  77     function(phy, tip, trim.internal = TRUE, subtree = FALSE,
  78              root.edge = 0, rooted = is.rooted(phy), interactive = FALSE)
  79 {
  80     if (!inherits(phy, "phylo"))
  81         stop('object "phy" is not of class "phylo"')
  82
  83     Ntip <- length(phy$tip.label)
  84     ## find the tips to drop:
  85     if (interactive) {
  86         cat("Left-click close to the tips you want to drop; right-click when finished...\n")
  87         xy <- locator()
  88         nToDrop <- length(xy$x)
  89         tip <- integer(nToDrop)
  90         lastPP <- get("last_plot.phylo", envir = .PlotPhyloEnv)
  91         for (i in 1:nToDrop) {
  92             d <- sqrt((xy$x[i] - lastPP$xx)^2 + (xy$y[i] - lastPP$yy)^2)
  93             tip[i] <- which.min(d)
  94         }
  95     } else {
  96         if (is.character(tip))
  97             tip <- which(phy$tip.label %in% tip)
  98     }
  99
 100     if (!rooted && subtree) {
 101         phy <- root(phy, (1:Ntip)[-tip][1])
 102         root.edge <- 0
 103     }
 104
 105     phy <- reorder(phy)
 106     NEWROOT <- ROOT <- Ntip + 1
 107     Nnode <- phy$Nnode
 108     Nedge <- dim(phy$edge)[1]
 109     if (subtree) {
 110         trim.internal <- TRUE
 111         tr <- reorder(phy, "pruningwise")
 112         N <- .C("node_depth", as.integer(Ntip), as.integer(Nnode),
 113                 as.integer(tr$edge[, 1]), as.integer(tr$edge[, 2]),
 114                 as.integer(Nedge), double(Ntip + Nnode),
 115                 DUP = FALSE, PACKAGE = "ape")[[6]]
 116     }
 117     wbl <- !is.null(phy$edge.length)
 118     edge1 <- phy$edge[, 1] # local copies
 119     edge2 <- phy$edge[, 2] #
 120     keep <- !logical(Nedge)
 121
 122     ## find the tips to drop:
 123     if (is.character(tip))
 124         tip <- which(phy$tip.label %in% tip)
 125
 126     if (!rooted && subtree) {
 127         phy <- root(phy, (1:Ntip)[-tip][1])
 128         root.edge <- 0
 129     }
 130
 131     ## delete the terminal edges given by `tip':
 132     keep[match(tip, edge2)] <- FALSE
 133
 134     if (trim.internal) {
 135         ints <- edge2 > Ntip
 136         ## delete the internal edges that do not have anymore
 137         ## descendants (ie, they are in the 2nd col of `edge' but
 138         ## not in the 1st one)
 139         repeat {
 140             sel <- !(edge2 %in% edge1[keep]) & ints & keep
 141             if (!sum(sel)) break
 142             keep[sel] <- FALSE
 143         }
 144         if (subtree) {
 145             ## keep the subtending edge(s):
 146             subt <- edge1 %in% edge1[keep] & edge1 %in% edge1[!keep]
 147             keep[subt] <- TRUE
 148         }
 149         if (root.edge && wbl) {
 150             degree <- tabulate(edge1[keep])
 151             if (degree[ROOT] == 1) {
 152                 j <- integer(0) # will store the indices of the edges below the new root
 153                 repeat {
 154                     i <- which(edge1 == NEWROOT & keep)
 155                     j <- c(i, j)
 156                     NEWROOT <- edge2[i]
 157                     degree <- tabulate(edge1[keep])
 158                     if (degree[NEWROOT] > 1) break
 159                 }
 160                 keep[j] <- FALSE
 161                 if (length(j) > root.edge) j <- 1:root.edge
 162                 NewRootEdge <- sum(phy$edge.length[j])
 163                 if (length(j) < root.edge && !is.null(phy$root.edge))
 164                     NewRootEdge <- NewRootEdge + phy$root.edge
 165                 phy$root.edge <- NewRootEdge
 166             }
 167         }
 168     }
 169
 170     if (!root.edge) phy$root.edge <- NULL
 171
 172     ## drop the edges
 173     phy$edge <- phy$edge[keep, ]
 174     if (wbl) phy$edge.length <- phy$edge.length[keep]
 175
 176     ## find the new terminal edges (works whatever 'subtree' and 'trim.internal'):
 177     TERMS <- !(phy$edge[, 2] %in% phy$edge[, 1])
 178
 179     ## get the old No. of the nodes and tips that become tips:
 180     oldNo.ofNewTips <- phy$edge[TERMS, 2]
 181
 182     n <- length(oldNo.ofNewTips) # the new number of tips in the tree
 183
 184     ## the tips may not be sorted in increasing order of their
 185     ## in the 2nd col of edge, so no need to reorder $tip.label
 186     phy$edge[TERMS, 2] <- rank(phy$edge[TERMS, 2])
 187
 188     ## make new tip labels if necessary:
 189     if (subtree || !trim.internal) {
 190         ## get the logical indices of the tips that are kept within 'oldNo.ofNewTips':
 191         tips.kept <- oldNo.ofNewTips <= Ntip & !(oldNo.ofNewTips %in% tip)
 192         new.tip.label <- character(n)
 193         new.tip.label[tips.kept] <- phy$tip.label[-tip]
 194         ## get the numbers of the nodes that become tips:
 195         node2tip <- oldNo.ofNewTips[!tips.kept]
 196         new.tip.label[!tips.kept] <- if (subtree) {
 197             paste("[", N[node2tip], "_tips]", sep = "")
 198         } else {
 199             if (is.null(phy$node.label)) rep("NA", length(node2tip))
 200             else phy$node.label[node2tip - Ntip]
 201         }
 202         if (!is.null(phy$node.label))
 203             phy$node.label <- phy$node.label[-(node2tip - Ntip)]
 204         phy$tip.label <- new.tip.label
 205     } else phy$tip.label <- phy$tip.label[-tip]
 206
 207     ## update node.label if needed:
 208     if (!is.null(phy$node.label))
 209         phy$node.label <- phy$node.label[sort(unique(phy$edge[, 1])) - Ntip]
 210
 211     phy$Nnode <- dim(phy$edge)[1] - n + 1L # update phy$Nnode
 212
 213     ## The block below renumbers the nodes so that they conform
 214     ## to the "phylo" format -- same as in root()
 215     newNb <- integer(n + phy$Nnode)
 216     newNb[NEWROOT] <- n + 1L
 217     sndcol <- phy$edge[, 2] > n
 218     ## executed from right to left, so newNb is modified before phy$edge:
 219     phy$edge[sndcol, 2] <- newNb[phy$edge[sndcol, 2]] <-
 220         (n + 2):(n + phy$Nnode)
 221     phy$edge[, 1] <- newNb[phy$edge[, 1]]
 222     storage.mode(phy$edge) <- "integer"
 223     collapse.singles(phy)
 224 }