Deprecate isFALSE()

DESCRIPTION

@@ -20,8 +20,8 @@ Suggests:
     rstudioapi,
     tinytex (>= 0.30),
     mime,
-    markdown,
-    knitr,
+    markdown (>= 1.5),
+    knitr (>= 1.42),
     htmltools,
     remotes,
     pak,

NEWS.md

@@ -2,6 +2,8 @@
 
 - Added a function `is_arm64()` to test the CPU type (thanks, @AlbanSagouis, #72).
 
+- Started deprecating `xfun::isFALSE()` in favor of `base::isFALSE()` for R >= 3.5.0 (thanks, @mmaechler, #66); `isFALSE()` will eventually be removed from **xfun** when we do not need to support R < 3.5.0.
+
 # CHANGES IN xfun VERSION 0.36
 
 - Added a new argument `resolve_symlink` to `normalize_path()` to get the absolute paths of symlinks without resolving them (with `resolve_symlink = FALSE`).

R/packages.R

@@ -47,7 +47,7 @@ pkg_attach = function(
     suppressPackageStartupMessages(base::library(...))
   }
   for (i in c(...)) {
-    if (!isFALSE(install) && !loadable(i)) pkg_install(i, install)
+    if (!base::isFALSE(install) && !loadable(i)) pkg_install(i, install)
     library(i, character.only = TRUE)
   }
 }
@@ -60,7 +60,7 @@ pkg_load = function(..., error = TRUE, install = FALSE) {
   if (n == 0) return(invisible(res))
   for (i in seq_len(n)) {
     res[i] = loadable(p <- pkg[i])
-    if (!isFALSE(install) && !res[i]) {
+    if (!base::isFALSE(install) && !res[i]) {
       pkg_install(p, install); res[i] = loadable(p)
     }
   }

R/paths.R

@@ -123,7 +123,7 @@ existing_files = function(x, first = FALSE, error = TRUE) {
   x = x[file_exists(x)]
   if (!first) return(x)
   x = head(x, 1)
-  if (length(x) != 1 && !isFALSE(error)) {
+  if (length(x) != 1 && !base::isFALSE(error)) {
     if (isTRUE(error)) error = 'None of the specified files exist.'
     stop(error, call. = FALSE)
   }

R/session.R

@@ -106,7 +106,7 @@ do_once = function(task, option, hint = c(
   'If you never want to see this message,',
   sprintf('you may set options(%s = FALSE) in your .Rprofile.', option)
 )) {
-  if (isFALSE(getOption(option))) return(invisible())
+  if (base::isFALSE(getOption(option))) return(invisible())
   task
   hint = paste(hint, collapse = ' ')
   if (hint != '') message(hint)

R/utils.R

@@ -90,17 +90,31 @@ in_dir = function(dir, expr) {
   expr
 }
 
-#' Test if an object is identical to \code{FALSE}
+#' Test if an object is \code{FALSE}
 #'
-#' A simple abbreviation of \code{identical(x, FALSE)}.
+#' For R versions lower than 3.5.0, this function is a simple abbreviation of
+#' \code{identical(x, FALSE)}. For higher R versions, this function calls
+#' \code{base::isFALSE()}.
 #' @param x An R object.
+#' @note This function will be deprecated in the future. We recommend that you
+#'   use \code{base::\link[base]{isFALSE}()} instead. If you have to support R
+#'   versions lower than 3.5.0, you may use \code{identical(x, FALSE)}, but
+#'   please note that it is not equivalent to \code{base::isFALSE()}.
 #' @export
-#' @examples
+#' @keywords internal
+#' @examplesIf getRversion() < '3.5.0'
 #' library(xfun)
 #' isFALSE(TRUE)  # false
 #' isFALSE(FALSE)  # true
 #' isFALSE(c(FALSE, FALSE))  # false
-isFALSE = function(x) identical(x, FALSE)
+isFALSE = function(x) {
+  if (!('isFALSE' %in% ls(baseenv()))) return(identical(x, FALSE))
+  do_once((if (is_R_CMD_check()) stop else warning)(
+    'The function xfun::isFALSE() will be deprecated in the future. Please ',
+    'consider using base::isFALSE(x) or identical(x, FALSE) instead.'
+  ), 'xfun.isFALSE.message', '')
+  base::isFALSE(x)
+}
 
 #' Parse R code and do not keep the source
 #'