Merge pull request #16 from poissonconsulting/f-with-timer

NAMESPACE

@@ -13,4 +13,5 @@ export(tmr_round)
 export(tmr_start)
 export(tmr_stop)
 export(tmr_timer)
+export(with_timer)
 import(hms)

R/hmstimer-package.R

@@ -4,5 +4,6 @@
 # The following block is used by usethis to automatically manage
 # roxygen namespace tags. Modify with care!
 ## usethis namespace: start
+#' @import hms
 ## usethis namespace: end
 NULL

R/local-timer.R

@@ -1,13 +1,18 @@
 #' Local Timer
 #'
+#' Called for the side effect of providing a message of the time 
+#' required to execute the rest of the function.
+#' 
 #' @inheritParams params
+#' @seealso [with_timer()]
 #'
-#' @return An invisible copy of the hmstimer object.
 #' @export
 #'
 #' @examples
 #' fun <- function() {
 #'   local_timer()
+#'   Sys.sleep(0.1)
+#'   10
 #' }
 #' fun()
 local_timer <- function(.local_envir = rlang::caller_env()) {

R/params.R

@@ -1,6 +1,7 @@
 #' Parameter Descriptions for hmstimer Functions
 #' 
-#' @param .local_envir The environment to use for scoping
+#' @param .local_envir The environment to use for scoping.
+#' @param code Code to time.
 #' @param digits A whole number of the number of decimal places.
 #' @param seconds A non-negative numeric scalar of the initial number of seconds.
 #' @param start A flag indicating whether to start the timer.

R/with-timer.R

@@ -0,0 +1,25 @@
+#' With Timer
+#'
+#' @inheritParams params
+#'
+#' @return The result of executing the code.
+#' @seealso [local_timer()]
+#' @export 
+#'
+#' @examples
+#' fun <- function() {
+#'   Sys.sleep(0.1)
+#'   10
+#' }
+#' with_timer(fun())
+#' 
+#' with_timer({
+#'  for(i in 1:2) {
+#'   Sys.sleep(0.1)
+#'  }
+#'  20
+#' })
+with_timer <- function(code) {
+  local_timer()
+  force(code)
+}

_pkgdown.yml

@@ -27,3 +27,4 @@ reference:
   desc: Miscellaneous functions
   contents:
   - local_timer
+  - with_timer

tests/testthat/test-local-timer.R

@@ -2,17 +2,17 @@ test_that("local_timer", {
   fun <- function(x) {
     tmr <- local_timer()
     Sys.sleep(0.1)
-    NULL
+    10
   }
-  expect_message(fun(), "^00:00:00\\.\\d{3,3}\\s$")
+  expect_message(expect_identical(fun(), 10), "^00:00:00\\.\\d{3,3}\\s$")
 })
 
 test_that("test_local_timer()", {
   test_local_timer <- function() {
     local_timer()
     Sys.sleep(0.1)
-    NULL
+    20
   }
 
-  expect_message(test_local_timer(), "^00:00:00\\.\\d{3,3}\\s$")
+  expect_message(expect_identical(test_local_timer(), 20), "^00:00:00\\.\\d{3,3}\\s$")
 })

tests/testthat/test-with-timer.R

@@ -0,0 +1,17 @@
+test_that("with_timer", {
+  fun <- function() {
+    Sys.sleep(0.1)
+    10
+  }
+  expect_message(expect_identical(with_timer(fun()), 10), "^00:00:00\\.\\d{3,3}\\s$")
+})
+
+test_that("with_timer", {
+  expect_message(expect_identical(with_timer({
+    for(i in 1:2) {
+      Sys.sleep(0.1)
+    }
+    20
+  }
+    ), 20), "^00:00:00\\.\\d{3,3}\\s$")
+})