test howManyRC() and prettyRange() 🛡️

Author: Kevin Cazelles

.gitignore

@@ -5,7 +5,6 @@ Makefile
 tests/testthat/*.pdf
 pkg2date.R
 record_updates.txt
-inst/doc
 inst/dataFormat
 inst/tmp
 

R/howManyRC.R

@@ -3,22 +3,25 @@
 #' Compute the number of rows and columns to split a graphic window into panels
 #' as equally as possible.
 #'
-#' @param n a number.
+#' @param n a positive integer (or corecible as is).
 #'
 #' @export
 #'
 #' @return
 #' A vector of two elements: the number of rows followed by the number of columns.
 
 howManyRC <- function(n) {
+    n <- as.integer(n[1L])
+    stopifnot(n > 0)
+    ##
     sqr <- sqrt(n)
     fsq <- floor(sqr)
     nbr <- nbc <- fsq
-    # 
-    if (sqr - fsq != 0) 
+    #
+    if (sqr - fsq != 0)
         nbr <- fsq + 1
-    if (n - nbr * nbc > 0) 
+    if (n - nbr * nbc > 0)
         nbc <- fsq + 1
-    # 
+    #
     c(nbr, nbc)
 }

R/prettyRange.R

@@ -10,7 +10,7 @@
 #' @export
 #'
 #' @return
-#' A vector of two values that corresponds to the range of values.
+#' A vector of two values specifying the pretty the range of values.
 #'
 #' @details
 #' This function intends to generate range with round values.
@@ -24,32 +24,35 @@
 #' range(vec)
 #' prettyRange(vec)
 #' # Example 2:
-#' prettyRange(c(3.85,3.88245))
+#' prettyRange(c(3.849,3.88245))
 
 prettyRange <- function(x) {
     ## --- format checking
     rgx <- as.numeric(range(x))
+    ## Not that below also test the case where length is 1!
+    stopifnot(min(rgx) != max(rgx))
     ## --- Assess the range of values
     dif <- rgx[2L] - rgx[1L]
     pow <- floor(log(dif, 10))
     ## --- Get the 'fixed part' (e.g. if the range values is [3.85;3.88] then we set
     ## 3.8 apart.)
     base <- floor(rgx[1L]/10^pow) * 10^pow
     rgx <- rgx - base
-    ## ---
+    ## --- Create a sequence of small values to select the min and max
     seqp <- 10^(pow + 1) * seq(0, 1.1, 0.05)
     minp <- seqp - rgx[1L]
     minpa <- abs(minp)
     indp <- which(minpa == min(minpa))
-    if (minp[indp] > 0) 
+    if (minp[indp] > 0)
         indp <- indp - 1
     rgx[1L] <- seqp[indp]
     ## ---
     maxp <- seqp - rgx[2L]
     maxpa <- abs(maxp)
     indp <- which(maxpa == min(maxpa))
-    if (maxp[indp] < 0) 
+    if (maxp[indp] < 0)
         indp <- indp + 1
     rgx[2L] <- seqp[indp]
-    return(rgx + base)
+    ##
+    rgx + base
 }