or: Alternation

Description

Match one string or another.

Usage

or(..., capture = FALSE)
x %|% y
or1(x, capture = FALSE)

Arguments

...

Character vectors.

capture

A logical value indicating whether or not the result should be captured. See note.

A character vector.

Value

A character vector representing part or all of a regular expression.

References

http://www.regular-expressions.info/alternation.html

Examples

Run this code

# or takes an arbitrary number of arguments and groups them without capture
# Notice the recycling of inputs
or(letters, month.abb, "foo")

# or1 takes a single character vector
or1(c(letters, month.abb, "foo")) # Not the same as before!

# Capture the group
or1(letters, capture = TRUE)

# Don't create a group
or1(letters, capture = NA)

# The pipe operator doesn't group
letters %|% month.abb %|% "foo"

# Usage
(rx <- or("dog", "cat", "hippopotamus"))
stringi::stri_detect_regex(c("boondoggle", "caterwaul", "water-horse"), rx)