Export %||%

tidyverse · Nov 11, 2015 · 9b1c44b · 9b1c44b
1 parent 4133c8b
commit 9b1c44b
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 2 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,6 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
 export("%>%")
+export("%||%")
 export(array_branch)
 export(array_tree)
 export(as_function)

diff --git a/NEWS.md b/NEWS.md
@@ -19,3 +19,5 @@
 
 * `list_along()` and `rep_along()` generalise the idea of `seq_along(). 
   (#122).
+
+* `%||%` is now exported (#109).
diff --git a/R/utils.R b/R/utils.R
@@ -95,8 +95,21 @@ names2 <- function(x) {
   names(x) %||% rep("", length(x))
 }
 
-"%||%" <- function(x, y) {
-  if(is.null(x)) {
+#' Default value for \code{NULL}.
+#'
+#' This infix function makes it easy to replace \code{NULL}s with a
+#' default value. It's inspired by the way that Ruby's or operation (\code{||})
+#' works.
+#'
+#' @param x,y If \code{x} is NULL, will return \code{y}; otherwise returns
+#'   \code{x}.
+#' @export
+#' @name null-default
+#' @examples
+#' 1 %||% 2
+#' NULL %||% 2
+`%||%` <- function(x, y) {
+  if (is.null(x)) {
     y
   } else {
     x

diff --git a/man/null-default.Rd b/man/null-default.Rd