assert_is_monotonic_increasing

Is the vector monotonically increasing or decreasing?

Checks to see if the input is monotonically increasing or decreasing.

Usage
assert_is_monotonic_increasing(x, strictly = FALSE, severity = getOption("assertive.severity", "stop"))
assert_is_monotonic_decreasing(x, strictly = FALSE, severity = getOption("assertive.severity", "stop"))
is_monotonic_increasing(x, strictly = FALSE, .xname = get_name_in_parent(x))
is_monotonic_decreasing(x, strictly = FALSE, .xname = get_name_in_parent(x))
Arguments
x
Input to check.
strictly
Logical. If TRUE, the input is checked for being strictly monotonic; that is, consecutive values cannot be equal.
severity
How severe should the consequences of the assertion be? Either "stop", "warning", "message", or "none".
.xname
Not intended to be used directly.
Aliases
  • assert_is_monotonic_decreasing
  • assert_is_monotonic_increasing
  • is_monotonic
  • is_monotonic_decreasing
  • is_monotonic_increasing
Examples
library(assertive.properties) x <- c(1, 2, 2, 1, 3, 2) is_monotonic_increasing(x) is_monotonic_increasing(x, TRUE) is_monotonic_decreasing(x) is_monotonic_decreasing(x, TRUE) # Also works with, e.g., dates & times is_monotonic_increasing(Sys.time() + x) # These checks should fail assertive.base::dont_stop({ assert_is_monotonic_increasing(x) assert_is_monotonic_decreasing(x) })
Documentation reproduced from package assertive.properties, version 0.0-4, License: GPL (>= 3)

Community examples

Looks like there are no examples yet.