R/read.tree.R

   1 ## read.tree.R (2009-04-27)
   2
   3 ##   Read Tree Files in Parenthetic Format
   4
   5 ## Copyright 2002-2009 Emmanuel Paradis and Daniel Lawson
   6
   7 ## This file is part of the R-package `ape'.
   8 ## See the file ../COPYING for licensing issues.
   9
  10 tree.build <- function(tp)
  11 {
  12     add.internal <- function() {
  13         edge[j, 1] <<- current.node
  14         edge[j, 2] <<- current.node <<- node <<- node + 1L
  15         j <<- j + 1L
  16     }
  17     add.terminal <- function() {
  18         edge[j, 1] <<- current.node
  19         edge[j, 2] <<- tip
  20         X <- unlist(strsplit(tpc[k], ":"))
  21         tip.label[tip] <<- X[1]
  22         edge.length[j] <<- as.numeric(X[2])
  23         k <<- k + 1L
  24         tip <<- tip + 1L
  25         j <<- j + 1L
  26     }
  27     go.down <- function() {
  28         l <- which(edge[, 2] == current.node)
  29         X <- unlist(strsplit(tpc[k], ":"))
  30         node.label[current.node - nb.tip] <<- X[1]
  31         edge.length[l] <<- as.numeric(X[2])
  32         k <<- k + 1L
  33         current.node <<- edge[l, 1]
  34     }
  35     if (!length(grep(",", tp))) {
  36         obj <- list(edge = matrix(c(2L, 1L), 1, 2))
  37         tp <- unlist(strsplit(tp, "[\\(\\):;]"))
  38         obj$edge.length <- as.numeric(tp[3])
  39         obj$Nnode <- 1L
  40         obj$tip.label <- tp[2]
  41         if (length(tp) == 4) obj$node.label <- tp[4]
  42         class(obj) <- "phylo"
  43         return(obj)
  44     }
  45
  46     tpc <- unlist(strsplit(tp, "[\\(\\),;]"))
  47     tpc <- tpc[nzchar(tpc)]
  48     ## the following 2 lines are (slightly) faster than using gsub()
  49     tsp <- unlist(strsplit(tp, NULL))
  50     skeleton <- tsp[tsp %in% c("(", ")", ",", ";")]
  51     nsk <- length(skeleton)
  52     nb.node <- sum(skeleton == ")")
  53     nb.tip <- sum(skeleton == ",") + 1
  54     ## We will assume there is an edge at the root;
  55     ## if so, it will be removed and put into a vector
  56     nb.edge <- nb.node + nb.tip
  57     node.label <- character(nb.node)
  58     tip.label <- character(nb.tip)
  59
  60     edge.length <- numeric(nb.edge)
  61     edge <- matrix(0L, nb.edge, 2)
  62     current.node <- node <- as.integer(nb.tip + 1) # node number
  63     edge[nb.edge, 2] <- node #
  64
  65     ## j: index of the line number of edge
  66     ## k: index of the line number of tpc
  67     ## tip: tip number
  68     j <- k <- tip <- 1L
  69
  70     for (i in 2:nsk) {
  71         if (skeleton[i] == "(") add.internal() # add an internal branch (on top)
  72         if (skeleton[i] == ",") {
  73             if (skeleton[i - 1] != ")") add.terminal() # add a terminal branch
  74         }
  75         if (skeleton[i] == ")") {
  76             if (skeleton[i - 1] == ",") { # add a terminal branch and go down one level
  77                 add.terminal()
  78                 go.down()
  79             }
  80             if (skeleton[i - 1] == ")") go.down() # go down one level
  81         }
  82     }
  83
  84     edge <- edge[-nb.edge, ]
  85     obj <- list(edge = edge, Nnode = nb.node, tip.label = tip.label)
  86     root.edge <- edge.length[nb.edge]
  87     edge.length <- edge.length[-nb.edge]
  88     if (!all(is.na(edge.length))) # added 2005-08-18
  89         obj$edge.length <- edge.length
  90     if (is.na(node.label[1])) node.label[1] <- ""
  91     if (any(nzchar(node.label))) obj$node.label <- node.label
  92     if (!is.na(root.edge)) obj$root.edge <- root.edge
  93     class(obj) <- "phylo"
  94     obj
  95 }
  96
  97 read.tree <- function(file = "", text = NULL, tree.names = NULL, skip = 0,
  98     comment.char = "#", keep.multi = FALSE, ...)
  99 {
 100     unname <- function(treetext) {
 101         nc <- nchar(treetext)
 102         tstart <- 1
 103         while (substr(treetext, tstart, tstart) != "(" && tstart <= nc)
 104             tstart <- tstart + 1
 105         if (tstart > 1)
 106             return(c(substr(treetext, 1, tstart - 1),
 107                      substr(treetext, tstart, nc)))
 108         return(c("", treetext))
 109     }
 110     if (!is.null(text)) {
 111         if (!is.character(text))
 112           stop("argument `text' must be of mode character")
 113         tree <- text
 114     } else {
 115         tree <- scan(file = file, what = "", sep = "\n", quiet = TRUE,
 116                      skip = skip, comment.char = comment.char, ...)
 117     }
 118     ## Suggestion from Eric Durand and Nicolas Bortolussi (added 2005-08-17):
 119     if (identical(tree, character(0))) {
 120         warning("empty character string.")
 121         return(NULL)
 122     }
 123     tree <- gsub("[ \t]", "", tree)
 124     tree <- unlist(strsplit(tree, NULL))
 125     y <- which(tree == ";")
 126     Ntree <- length(y)
 127     x <- c(1, y[-Ntree] + 1)
 128     ## Suggestion from Olivier François (added 2006-07-15):
 129     if (is.na(y[1])) return(NULL)
 130     STRING <- character(Ntree)
 131     for (i in 1:Ntree)
 132         STRING[i] <- paste(tree[x[i]:y[i]], sep = "", collapse = "")
 133
 134     tmp <- unlist(lapply(STRING, unname))
 135     tmpnames <- tmp[c(TRUE, FALSE)]
 136     STRING <- tmp[c(FALSE, TRUE)]
 137     if (is.null(tree.names) && any(nzchar(tmpnames)))
 138         tree.names <- tmpnames
 139
 140     colon <- grep(":", STRING)
 141     if (!length(colon)) {
 142         obj <- lapply(STRING, clado.build)
 143     } else if (length(colon) == Ntree) {
 144         obj <- lapply(STRING, tree.build)
 145     } else {
 146         obj <- vector("list", Ntree)
 147         obj[colon] <- lapply(STRING[colon], tree.build)
 148         nocolon <- (1:Ntree)[!1:Ntree %in% colon]
 149         obj[nocolon] <- lapply(STRING[nocolon], clado.build)
 150     }
 151     for (i in 1:Ntree) {
 152         ## Check here that the root edge is not incorrectly represented
 153         ## in the object of class "phylo" by simply checking that there
 154         ## is a bifurcation at the root
 155         ROOT <- length(obj[[i]]$tip.label) + 1
 156         if(sum(obj[[i]]$edge[, 1] == ROOT) == 1 && dim(obj[[i]]$edge)[1] > 1)
 157             stop(paste("There is apparently two root edges in your file: cannot read tree file.\n  Reading Newick file aborted at tree no.", i, sep = ""))
 158     }
 159     if (Ntree == 1 && !keep.multi) obj <- obj[[1]] else {
 160         if (!is.null(tree.names)) names(obj) <- tree.names
 161         class(obj) <- "multiPhylo"
 162     }
 163     obj
 164 }