Is vector monotonically decreasing

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

Usage

is_monotonic_decreasing(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_decreasing() examples
#----------------------------------------------------------------------------
library(bkbase)

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

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

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

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

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