Prepare new release v0.10.0

- Add new function toConditional()
- Add magrittr to Suggests (used in 1 example)
- Fix test (explicitly set stringsAsFactors)

Author: hsonne

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: kwb.utils
 Title: General Utility Functions Developed at KWB
-Version: 0.9.0.9000
+Version: 0.10.0
 Authors@R: 
     c(person(given = "Hauke",
              family = "Sonnenberg",
@@ -25,6 +25,7 @@ Suggests:
     testthat,
     covr,
     knitr,
+    magrittr,
     rmarkdown
 VignetteBuilder: 
     knitr

NAMESPACE

@@ -247,6 +247,7 @@ export(substSpecialChars)
 export(tableLookup)
 export(tempSubdirectory)
 export(textToObject)
+export(toConditional)
 export(toFactor)
 export(toFormula)
 export(toInches)

NEWS.md

@@ -1,6 +1,8 @@
-# Current
+# [kwb.utils 0.10.0](https://github.com/KWB-R/kwb.utils/releases/tag/v0.10.0) <small>2022-01-19</small>
 
 * add findChanges(), to be used by kwb.utils::hsEventsOnChange()
+* add toConditional()
+* allow to pass a "path" to getAttribute()
 
 # [kwb.utils 0.9.0](https://github.com/KWB-R/kwb.utils/releases/tag/v0.9.0) <small>2021-11-16</small>
 
@@ -9,7 +11,6 @@
 * Add new private functions: enumeration(), hintAvailable(), hintNoSuch(),
   stopIsNotBut(), 
 * checkForMissingColumns(), selectElements(): Use new private functions
-* Allow to pass a "path" to getAttribute()
 
 # [kwb.utils 0.8.0](https://github.com/KWB-R/kwb.utils/releases/tag/v0.8.0) <small>2021-02-19</small>
 

R/toConditional.R

@@ -0,0 +1,30 @@
+# toConditional ----------------------------------------------------------------
+
+#' Convert Function to Function that is Called if Condition is Met
+#'
+#' @param FUN a function
+#' @export
+#' @examples
+#' square <- function(x) x^2
+#' negate <- function(x) -x
+#' `%>%` <- magrittr::`%>%`
+#' do_square <- TRUE
+#' do_negate <- TRUE
+#' 10 %>%
+#'   toConditional(square)(do_square) %>%
+#'   toConditional(negate)(do_negate)
+toConditional <- function(FUN)
+{
+  stopifnot(is.function(FUN))
+
+  function(x, condition, ...) {
+
+    stopifnot(is.logical(condition), length(condition) == 1L)
+
+    if (! condition) {
+      return(x)
+    }
+
+    FUN(x, ...)
+  }
+}

man/toConditional.Rd

@@ -16,7 +16,8 @@ test_that("findChanges() works", {
   expect_identical(f(c("a", "b", "b", "c")), data.frame(
     starts_at = c(1L, 2L, 4L),
     ends_at = c(1L, 3L, 4L), 
-    value = c("a", "b", "c")
+    value = c("a", "b", "c"),
+    stringsAsFactors = FALSE
   ))
 
   # Take care with real numbers!