Check that x contains numbers — is

Check that x is a vector of the correct length with numbers of the correct sign.

Usage

is_number(x, allow_zerolength = FALSE, allow_NA = FALSE, allow_NaN = FALSE)

all_numbers(x, allow_zerolength = FALSE, allow_NA = FALSE, allow_NaN = FALSE)

is_nonnegative(
  x,
  allow_zerolength = FALSE,
  allow_NA = FALSE,
  allow_NaN = FALSE
)

all_nonnegative(
  x,
  allow_zerolength = FALSE,
  allow_NA = FALSE,
  allow_NaN = FALSE
)

is_positive(x, allow_zerolength = FALSE, allow_NA = FALSE, allow_NaN = FALSE)

Arguments

x: object to check.
allow_zerolength: TRUE or FALSE: allow zero-length x of the correct type?
allow_NA: TRUE or FALSE: allow NA of the correct type in x?
allow_NaN: TRUE or FALSE: allow NaN?

Value

TRUE or FALSE indicating if x is a vector of the correct length only containing allowed numbers.

Details

is_number(), all_numbers(), all_nonnegative() and is_nonnegative() return TRUE for zero, whereas is_positive() returns FALSE for zero.

is_number(), is_nonnegative(), and is_positive() return TRUE for x with length one. all_numbers() and all_nonnegative() return TRUE for x with length larger than zero.

All these functions return TRUE:

for numeric-type zero-length x if allow_zerolength is TRUE.
for -Inf and Inf if it has the correct sign
for NA_integer_ and NA_real_ if allow_NA is TRUE (even then they return FALSE for NA_complex_ because that has mode complex instead of numeric)
for NaN (which has mode numeric, despite meaning 'not a number') if allow_NaN is TRUE.

Programming notes

is.numeric() checks the mode() of x, which is numeric for floating-point numbers such as 3.2 and integers such as 3L. In contrast, class(x) == "numeric" (or, more robust, inherits(x = x, what = "numeric")) would check the class() of x which is numeric for floating-point numbers but integer for integers (see the Note on names in is.numeric()).

Examples

is_number(x = 1) # TRUE
#> [1] TRUE
is_number(x = 3.14) # TRUE
#> [1] TRUE
is_number(x = c(1, 2)) # FALSE: incorrect length
#> [1] FALSE
all_numbers(x = c(1, 2)) # TRUE
#> [1] TRUE
is_number(x = "a") # FALSE: incorrect type
#> [1] FALSE
is_number(x = numeric(0)) # FALSE: incorrect length
#> [1] FALSE
is_number(x = numeric(0), allow_zerolength = TRUE) # TRUE
#> [1] TRUE
is_number(x = NA_real_) # FALSE
#> [1] FALSE
is_number(x = NA_real_, allow_NA = TRUE) # TRUE
#> [1] TRUE
is_number(x = NA_character_, allow_NA = TRUE) # FALSE: incorrect type
#> [1] FALSE
is_number(x = NaN, allow_NA = TRUE) # FALSE, need allow_NaN = TRUE to allow NaN
#> [1] FALSE
is_number(x = NaN, allow_NaN = TRUE) # TRUE
#> [1] TRUE
is_number(x = Inf) # TRUE
#> [1] TRUE
is_nonnegative(x = 3) # TRUE
#> [1] TRUE
is_nonnegative(x = 0) # TRUE
#> [1] TRUE
all_nonnegative(x = c(3, 0)) # TRUE
#> [1] TRUE
all_nonnegative(x = numeric(0), allow_zerolength = TRUE) # TRUE
#> [1] TRUE
is_positive(x = 3) # TRUE
#> [1] TRUE
is_positive(x = 0) # FALSE
#> [1] FALSE

Check that `x` contains numbers