adding the new function 'where'

[ape.git] / R / scales.R

diff --git a/R/scales.R b/R/scales.R
index 01f23f5fe96c8e263baf0f319284353de9b5b2ce..7176d1f5c6e19b1ab60ec11ff2633eb1725ec097 100644 (file)
--- a/R/scales.R
+++ b/R/scales.R
@@ -1,53 +1,76 @@
-## scales.R (2009-07-23)
+## scales.R (2011-05-31)
 
 ##   Add a Scale Bar or Axis to a Phylogeny Plot
 
 ## add.scale.bar: add a scale bar to a phylogeny plot
 ## axisPhylo: add a scale axis on the side of a phylogeny plot
 
-## Copyright 2002-2009 Emmanuel Paradis
+## Copyright 2002-2011 Emmanuel Paradis
 
 ## This file is part of the R-package `ape'.
 ## See the file ../COPYING for licensing issues.
 
-add.scale.bar <- function(x, y, length = NULL, ...)
+add.scale.bar <- function(x, y, length = NULL, ask = FALSE,
+                          lwd = 1, lcol = "black", ...)
 {
     lastPP <- get("last_plot.phylo", envir = .PlotPhyloEnv)
+    direc <- lastPP$direction
     if (is.null(length)) {
         nb.digit <-
-          if (lastPP$direction %in% c("rightwards", "leftwards")) diff(range(lastPP$xx))
+          if (direc %in% c("rightwards", "leftwards")) diff(range(lastPP$xx))
           else diff(range(lastPP$yy))
         nb.digit <- ceiling(log10(nb.digit)) - 2
         length <- eval(parse(text = paste("1e", nb.digit, sep = "")))
     }
-    if (missing(x) || missing(y)) {
-        switch(lastPP$direction,
-               "rightwards" = {
-                   x <- 0
-                   y <- 1
-                   segments(x, y, x + length, y)
-                   text(x + length * 1.1, y, as.character(length), adj = c(0, 0.5), ...)
-               },
-               "leftwards" = {
-                   x <- max(lastPP$xx)
-                   y <- 1
-                   segments(x - length, y, x, y)
-                   text(x - length * 1.1, y, as.character(length), adj = c(1, 0.5), ...)
-               },
-               "upwards" = {
-                   x <- max(lastPP$xx)
-                   y <- 0
-                   segments(x, y, x, y + length)
-                   text(x, y + length * 1.1, as.character(length), adj = c(0, 0.5), srt = 90, ...)
-               },
-               "downwards" = {
-                   x <- 1
-                   y <- max(lastPP$yy)
-                   segments(x, y - length, x, y)
-                   text(x, y - length * 1.1, as.character(length), adj = c(0, 0.5), srt = 270, ...)
-               }
-         )
+
+    if (ask) {
+        cat("\nClick where you want to draw the bar\n")
+        x <- unlist(locator(1))
+        y <- x[2]
+        x <- x[1]
+    } else if (missing(x) || missing(y)) {
+        if (lastPP$type %in% c("phylogram", "cladogram")) {
+            switch(direc,
+                   "rightwards" = {
+                       x <- 0
+                       y <- 1
+                   },
+                   "leftwards" = {
+                       x <- max(lastPP$xx)
+                       y <- 1
+                   },
+                   "upwards" = {
+                       x <- max(lastPP$xx)
+                       y <- 0
+                   },
+                   "downwards" = {
+                       x <- 1
+                       y <- max(lastPP$yy)
+                   })
+        } else {
+            direc <- "rightwards" # just to be sure for below
+            x <- lastPP$x.lim[1]
+            y <- lastPP$y.lim[1]
+        }
     }
+
+    switch(direc,
+           "rightwards" = {
+               segments(x, y, x + length, y, col = lcol, lwd = lwd)
+               text(x + length * 1.1, y, as.character(length), adj = c(0, 0.5), ...)
+           },
+           "leftwards" = {
+               segments(x - length, y, x, y, col = lcol, lwd = lwd)
+               text(x - length * 1.1, y, as.character(length), adj = c(1, 0.5), ...)
+           },
+           "upwards" = {
+               segments(x, y, x, y + length, col = lcol, lwd = lwd)
+               text(x, y + length * 1.1, as.character(length), adj = c(0, 0.5), srt = 90, ...)
+           },
+           "downwards" = {
+               segments(x, y - length, x, y, col = lcol, lwd = lwd)
+               text(x, y - length * 1.1, as.character(length), adj = c(0, 0.5), srt = 270, ...)
+           })
 }
 
 axisPhylo <- function(side = 1, ...)