Is vector monotonically increasing

Returns TRUE if all values in a x are monotonically increasing. Returns FALSE for non-numeric input, NULL, and zero-length vectors.

Usage

is_monotonic_increasing(x, na.rm = FALSE)

Arguments

x

(numeric)
The vector to be tested.

na.rm

(scalar logical)
Whether or not to remove/ignore missing values from x.

Value

Scalar logical

Examples

#----------------------------------------------------------------------------
# is_monotonic_increasing() examples
#----------------------------------------------------------------------------
library(bkbase)

is_monotonic_increasing(-10:10)
#> [1] TRUE
is_monotonic_increasing(c(0, 1, 1, 2, 2, 3.5))
#> [1] TRUE
is_monotonic_increasing(1)
#> [1] TRUE

is_monotonic_increasing(3:1)
#> [1] FALSE

is_monotonic_increasing(c(1:3, NA))
#> Warning: Missing values were present. is_monotonic_increasing(na.rm = FALSE) always returns FALSE in this case. Maybe you want 'na.rm = TRUE'.
#> [1] FALSE
is_monotonic_increasing(c(1:3, NA), na.rm = TRUE)
#> [1] TRUE

is_monotonic_increasing(NA_real_)
#> Warning: Missing values were present. is_monotonic_increasing(na.rm = FALSE) always returns FALSE in this case. Maybe you want 'na.rm = TRUE'.
#> [1] FALSE
is_monotonic_increasing(NA_real_, na.rm = TRUE)
#> [1] FALSE

is_monotonic_increasing(numeric(0L))
#> [1] FALSE
is_monotonic_increasing(NULL)
#> [1] FALSE