3 ## Manipulations and Comparisons of DNA Sequences
5 ## Copyright 2002-2012 Emmanuel Paradis
7 ## This file is part of the R-package `ape'.
8 ## See the file ../COPYING for licensing issues.
10 labels.DNAbin <- function(object, ...)
12 if (is.list(object)) return(names(object))
13 if (is.matrix(object)) return(rownames(object))
17 del.gaps <- function(x)
19 deleteGaps <- function(x) {
21 if (length(i)) x[-i] else x
24 if (!inherits(x, "DNAbin")) x <- as.DNAbin(x)
27 y <- vector("list", n)
28 for (i in 1:n) y[[i]] <- x[i, ]
29 names(y) <- rownames(x)
33 if (!is.list(x)) return(deleteGaps(x))
34 x <- lapply(x, deleteGaps)
39 as.alignment <- function(x)
41 if (is.list(x)) n <- length(x)
42 if (is.matrix(x)) n <- dim(x)[1]
47 seq[i] <- paste(x[[i]], collapse = "")
50 nam <- dimnames(x)[[1]]
52 seq[i] <- paste(x[i, ], collapse = "")
54 obj <- list(nb = n, seq = seq, nam = nam, com = NA)
55 class(obj) <- "alignment"
59 "[.DNAbin" <- function(x, i, j, drop = FALSE)
64 if (nargs() == 2 && !missing(i)) ans <- x[i]
67 if (missing(i)) i <- 1:nd[1]
68 if (missing(j)) j <- 1:nd[2]
69 ans <- x[i, j, drop = drop]
72 if (missing(i)) i <- 1:length(x)
79 as.matrix.DNAbin <- function(x, ...)
82 if (length(unique(unlist(lapply(x, length)))) != 1)
83 stop("DNA sequences in list not of the same length.")
87 x <- matrix(unlist(x), n, s, byrow = TRUE)
94 as.list.DNAbin <- function(x, ...)
96 if (is.list(x)) return(x)
97 if (is.null(dim(x))) obj <- list(x) # cause is.vector() doesn't work
100 obj <- vector("list", n)
101 for (i in 1:n) obj[[i]] <- x[i, ]
102 names(obj) <- rownames(x)
104 class(obj) <- "DNAbin"
108 rbind.DNAbin <- function(...)
109 ### works only with matrices for the moment
113 if (n == 1) return(obj[[1]])
115 if (!is.matrix(obj[[1]]))
116 stop("the 'rbind' method for \"DNAbin\" accepts only matrices")
117 NC <- unlist(lapply(obj, ncol))
118 if (length(unique(NC)) > 1)
119 stop("matrices do not have the same number of columns.")
120 for (i in 1:n) class(obj[[i]]) <- NULL
121 for (i in 2:n) obj[[1]] <- rbind(obj[[1]], obj[[i]])
122 structure(obj[[1]], class = "DNAbin")
126 function(..., check.names = TRUE, fill.with.gaps = FALSE,
128 ### works only with matrices for the moment
132 if (n == 1) return(obj[[1]])
134 if (!is.matrix(obj[[1]]))
135 stop("the 'cbind' method for \"DNAbin\" accepts only matrices")
136 NR <- unlist(lapply(obj, nrow))
137 for (i in 1:n) class(obj[[i]]) <- NULL
139 nms <- unlist(lapply(obj, rownames))
140 if (fill.with.gaps) {
141 NC <- unlist(lapply(obj, ncol))
143 ans <- matrix(as.raw(4), length(nms), sum(NC))
147 to <- from + NC[i] - 1
148 tmp <- rownames(obj[[i]])
149 nmsi <- tmp[tmp %in% nms]
150 ans[nmsi, from:to] <- obj[[i]][nmsi, , drop = FALSE]
156 nms <- names(tab)[which(ubi)]
157 ans <- obj[[1]][nms, , drop = FALSE]
159 ans <- cbind(ans, obj[[i]][nms, , drop = FALSE])
160 if (!quiet && !all(ubi))
161 warning("some rows were dropped.")
164 if (length(unique(NR)) > 1)
165 stop("matrices do not have the same number of rows.")
166 ans <- matrix(unlist(obj), NR)
167 rownames(ans) <- rownames(obj[[1]])
169 class(ans) <- "DNAbin"
173 c.DNAbin <- function(..., recursive = FALSE)
175 if (!all(unlist(lapply(list(...), is.list))))
176 stop("the 'c' method for \"DNAbin\" accepts only lists")
177 structure(NextMethod("c"), class = "DNAbin")
180 print.DNAbin <- function(x, printlen = 6, digits = 3, ...)
186 cat("1 DNA sequence in binary format stored in a list.\n\n")
187 cat("Sequence length:", length(x[[1]]), "\n\n")
188 cat("Label:", nms, "\n\n")
190 cat(n, "DNA sequences in binary format stored in a list.\n\n")
191 tmp <- unlist(lapply(x, length))
195 cat("All sequences of same length:", maxi, "\n")
197 cat("Mean sequence length:", round(mean(tmp), 3), "\n")
198 cat(" Shortest sequence:", mini, "\n")
199 cat(" Longest sequence:", maxi, "\n")
203 nms <- nms[1:printlen]
206 cat("\nLabels:", paste(nms, collapse = " "), TAIL)
208 } else if (is.matrix(x)) {
211 cat(nd[1], "DNA sequences in binary format stored in a matrix.\n\n")
212 cat("All sequences of same length:", nd[2], "\n")
214 if (printlen < nd[1]) {
215 nms <- nms[1:printlen]
218 cat("\nLabels:", paste(nms, collapse = " "), TAIL)
220 cat("1 DNA sequence in binary format stored in a vector.\n\n")
221 cat("Sequence length:", length(x), "\n\n")
223 cat("Base composition:\n")
224 print(round(base.freq(x), digits))
227 as.DNAbin <- function(x, ...) UseMethod("as.DNAbin")
229 ._cs_ <- c("a", "g", "c", "t", "r", "m", "w", "s", "k",
230 "y", "v", "h", "d", "b", "n", "-", "?")
232 ._bs_ <- c(136, 72, 40, 24, 192, 160, 144, 96, 80,
233 48, 224, 176, 208, 112, 240, 4, 2)
235 as.DNAbin.character <- function(x, ...)
240 ans[which(x == ._cs_[i])] <- as.raw(._bs_[i])
241 ans[which(x == "-")] <- as.raw(4)
242 ans[which(x == "?")] <- as.raw(2)
245 dimnames(ans) <- dimnames(x)
247 class(ans) <- "DNAbin"
251 as.DNAbin.alignment <- function(x, ...)
254 x$seq <- tolower(x$seq)
255 ans <- matrix("", n, nchar(x$seq[1]))
257 ans[i, ] <- strsplit(x$seq[i], "")[[1]]
258 rownames(ans) <- gsub(" +$", "", gsub("^ +", "", x$nam))
259 as.DNAbin.character(ans)
262 as.DNAbin.list <- function(x, ...)
264 obj <- lapply(x, as.DNAbin)
265 class(obj) <- "DNAbin"
269 as.character.DNAbin <- function(x, ...)
272 ans <- character(length(xx))
274 ans[which(xx == ._bs_[i])] <- ._cs_[i]
275 ans[which(xx == 4)] <- "-"
276 ans[which(xx == 2)] <- "?"
279 dimnames(ans) <- dimnames(xx)
283 if (is.list(x)) lapply(x, f) else f(x)
286 base.freq <- function(x, freq = FALSE, all = FALSE)
288 if (is.list(x)) x <- unlist(x)
290 BF <-.C("BaseProportion", x, n, double(17),
291 DUP = FALSE, NAOK = TRUE, PACKAGE = "ape")[[3]]
292 names(BF) <- c("a", "c", "g", "t", "r", "m", "w", "s",
293 "k", "y", "v", "h", "d", "b", "n", "-", "?")
295 if (!freq) BF <- BF / n
298 if (!freq) BF <- BF / sum(BF)
303 Ftab <- function(x, y = NULL)
309 if (length(x) != length(y))
310 stop("'x' and 'y' not of same lenght")
311 } else { # 'x' is a matrix
312 y <- x[2, , drop = TRUE]
313 x <- x[1, , drop = TRUE]
318 if (length(x) != length(y))
319 stop("'x' and 'y' not of same lenght")
321 out <- matrix(0, 4, 4)
322 k <- c(136, 40, 72, 24)
327 out[i, j] <- sum(a & b)
330 dimnames(out)[1:2] <- list(c("a", "c", "g", "t"))
334 GC.content <- function(x) sum(base.freq(x)[2:3])
336 seg.sites <- function(x)
338 if (is.list(x)) x <- as.matrix(x)
339 if (is.vector(x)) n <- 1
340 else { # 'x' is a matrix
345 if (n == 1) return(integer(0))
346 ans <- .C("SegSites", x, n, s, integer(s),
347 DUP = FALSE, NAOK = TRUE, PACKAGE = "ape")
348 which(as.logical(ans[[4]]))
351 dist.dna <- function(x, model = "K80", variance = FALSE, gamma = FALSE,
352 pairwise.deletion = FALSE, base.freq = NULL,
355 MODELS <- c("RAW", "JC69", "K80", "F81", "K81", "F84", "T92", "TN93",
356 "GG95", "LOGDET", "BH87", "PARALIN", "N", "TS", "TV",
357 "INDEL", "INDELBLOCK")
358 imod <- pmatch(toupper(model), MODELS)
360 stop(paste("'model' must be one of:",
361 paste("\"", MODELS, "\"", sep = "", collapse = " ")))
362 if (imod == 11 && variance) {
363 warning("computing variance not available for model BH87")
366 if (gamma && imod %in% c(1, 5:7, 9:17)) {
367 warning(paste("gamma-correction not available for model", model))
370 if (is.list(x)) x <- as.matrix(x)
371 nms <- dimnames(x)[[1]]
376 if (imod %in% c(4, 6:8)) {
377 BF <- if (is.null(base.freq)) base.freq(x) else base.freq
380 if (imod %in% 16:17) pairwise.deletion <- TRUE
382 if (!pairwise.deletion) {
383 keep <- .C("GlobalDeletionDNA", x, n, s,
384 rep(1L, s), PACKAGE = "ape")[[4]]
385 x <- x[, as.logical(keep)]
388 Ndist <- if (imod == 11) n*n else n*(n - 1)/2
389 var <- if (variance) double(Ndist) else 0
390 if (!gamma) gamma <- alpha <- 0
391 else alpha <- gamma <- 1
392 d <- .C("dist_dna", x, n, s, imod, double(Ndist), BF,
393 as.integer(pairwise.deletion), as.integer(variance),
394 var, as.integer(gamma), alpha, DUP = FALSE, NAOK = TRUE,
396 if (variance) var <- d[[9]]
400 dimnames(d) <- list(nms, nms)
403 attr(d, "Labels") <- nms
404 attr(d, "Diag") <- attr(d, "Upper") <- FALSE
405 attr(d, "call") <- match.call()
406 attr(d, "method") <- model
408 if (as.matrix) d <- as.matrix(d)
410 if (variance) attr(d, "variance") <- var
414 image.DNAbin <- function(x, what, col, bg = "white", xlab = "", ylab = "",
415 show.labels = TRUE, cex.lab = 1, legend = TRUE, ...)
418 if (missing(what)) c("a", "g", "c", "t", "n", "-") else tolower(what)
420 col <- c("red", "yellow", "green", "blue", "grey", "black")
421 n <- (dx <- dim(x))[1] # number of sequences
422 s <- dx[2] # number of sites
423 y <- integer(N <- length(x))
425 col <- rep(col, length.out = ncl)
426 brks <- 0.5:(ncl + 0.5)
429 k <- ._bs_[._cs_ == what[i]]
431 if (L <- length(sel)) {
441 ## if there's no 0 in y, must drop 'bg' from the cols passed to image:
444 leg.txt <- toupper(what)
447 leg.txt <- c(toupper(what), "others")
449 brks <- c(-0.5, brks)
451 yaxt <- if (show.labels) "n" else "s"
452 graphics::image.default(1:s, 1:n, t(y), col = co, xlab = xlab,
453 ylab = ylab, yaxt = yaxt, breaks = brks, ...)
455 mtext(rownames(x), side = 2, line = 0.1, at = 1:n,
456 cex = cex.lab, adj = 1, las = 1)
460 yy <- psr[4] * (0.5 + 0.5/par("plt")[4])
461 legend(xx, yy, legend = leg.txt, pch = 22, pt.bg = leg.co,
462 pt.cex = 2, bty = "n", xjust = 0.5, yjust = 0.5,
463 horiz = TRUE, xpd = TRUE)