predicate-trend {arkhe}

Numeric Trend Predicates

Description

Check numeric objects:

• is_constant() checks for equality among all elements of a vector.

• is_increasing() and is_decreasing() check if a sequence of numbers is monotonically increasing or decreasing, respectively.

Usage

is_constant(x, tolerance = sqrt(.Machine$double.eps), na.rm = FALSE)

is_increasing(x, na.rm = FALSE)

is_decreasing(x, na.rm = FALSE)

is_greater(x, y, strict = FALSE, na.rm = FALSE)

is_lower(x, y, strict = FALSE, na.rm = FALSE)

Arguments

x, y

A numeric object to be tested.

tolerance

A numeric scalar giving the tolerance to check within.

na.rm

A logical scalar: should missing values (including NaN) be omitted?

strict

A logical scalar: should strict inequality be used?

Value

A logical scalar.

See Also

Other predicates: is_scalar, predicate-matrix, predicate-numeric, predicate-type, predicate-utils