Merge branch 'master' of https://github.com/HughParsonage/hutils

HughParsonage · May 12, 2018 · f6e2f39 · f6e2f39
2 parents 46e9fbf + d3d755e
commit f6e2f39
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 102 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -2,10 +2,11 @@ language: R
 matrix:
   include:
   - r: release
-    env: 
-    - HUTILS_BENCHMARK=TRUE
+    env:
+      - HUTILS_BENCHMARK=TRUE
   - r: release
-    - HUTILS_BENCHMARK=FALSE
+    env:
+      - HUTILS_BENCHMARK=FALSE
   - r: devel
 cache: packages
 latex: true

diff --git a/R/auc.R b/R/auc.R
@@ -6,7 +6,7 @@
 #'  an ordered factor, or the unique values are \code{FALSE} and \code{TRUE} (case-insensitively).
 #'  Anything else is an error.
 #' @param pred Numeric (double) vector the same length as \code{actual} giving the predicted probability of \code{TRUE}. Must be a numeric vector the same length as \code{actual}.
-#' @source Source code based on \code{\link[Metrics]{auc}} from Ben Hamner and Michael Frasco and Erin LeDell from the Metrics package.
+#' @source Source code based on \code{Metrics::auc} from Ben Hamner and Michael Frasco and Erin LeDell from the Metrics package.
 #' @export auc
 
 #' @author
@@ -30,7 +30,8 @@ auc <- function(actual, pred) {
   if (!is.double(pred)) {
     # Switch the values
     if (is.logical(pred) && is.double(actual)) {
-      # Immeediate return
+      # Immediate return
+      message("`pred` was type logical and `actual` was type double, so interpreting as auc(pred, actual). Set to auc(actual, pred) for standard behaviour.")
       return(auc(actual = pred, pred = actual))
     }
 

diff --git a/inst/doc/hutils.R b/inst/doc/hutils.R
@@ -39,9 +39,8 @@ na <- sample(letters, size = 100e3, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::if_else(cnd, yes, no, na),
                hutils = hutils::if_else(cnd, yes, no, na),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 
 cnd <- sample(c(TRUE, FALSE, NA), size = 100e3, replace = TRUE)
 yes <- sample(letters, size = 1, replace = TRUE)
@@ -50,9 +49,8 @@ na <- sample(letters, size = 1, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::if_else(cnd, yes, no, na),
                hutils = hutils::if_else(cnd, yes, no, na),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 
 ## ----compare_coalesce----------------------------------------------------
 x <- sample(c(letters, NA), size = 100e3, replace = TRUE)
@@ -62,28 +60,25 @@ C <- sample(c(letters, NA), size = 100e3, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::coalesce(x, A, B, C),
                hutils = hutils::coalesce(x, A, B, C),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 
 ## ----compare_coalesce_short_circuit_x------------------------------------
 x <- sample(c(letters), size = 100e3, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::coalesce(x, A, B, C),
                hutils = hutils::coalesce(x, A, B, C),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 
 ## ----compare_coalesce_short_circuit_A------------------------------------
 x <- sample(c(letters, NA), size = 100e3, replace = TRUE)
 A <- sample(c(letters), size = 100e3, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::coalesce(x, A, B, C),
                hutils = hutils::coalesce(x, A, B, C),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 
 ## ----canonical_drop_DT---------------------------------------------------
 DT <- data.table(A = 1:5, B = 1:5, C = 1:5)

diff --git a/inst/doc/hutils.Rmd b/inst/doc/hutils.Rmd
@@ -87,9 +87,8 @@ na <- sample(letters, size = 100e3, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::if_else(cnd, yes, no, na),
                hutils = hutils::if_else(cnd, yes, no, na),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 
 cnd <- sample(c(TRUE, FALSE, NA), size = 100e3, replace = TRUE)
 yes <- sample(letters, size = 1, replace = TRUE)
@@ -98,9 +97,8 @@ na <- sample(letters, size = 1, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::if_else(cnd, yes, no, na),
                hutils = hutils::if_else(cnd, yes, no, na),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 ```
 
 This speed advantage also appears to be true of `coalesce`:
@@ -113,9 +111,8 @@ C <- sample(c(letters, NA), size = 100e3, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::coalesce(x, A, B, C),
                hutils = hutils::coalesce(x, A, B, C),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 ```
 
 especially during short-circuits:
@@ -125,9 +122,8 @@ x <- sample(c(letters), size = 100e3, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::coalesce(x, A, B, C),
                hutils = hutils::coalesce(x, A, B, C),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 ```
 
 ```{r compare_coalesce_short_circuit_A}
@@ -136,9 +132,8 @@ A <- sample(c(letters), size = 100e3, replace = TRUE)
 
 microbenchmark(dplyr =  dplyr::coalesce(x, A, B, C),
                hutils = hutils::coalesce(x, A, B, C),
-               check = my_check) %T>%
-  print %>%
-  autoplot
+               check = my_check) %>%
+  print
 ```