predicate-trend: Numeric Trend Predicates

In arkhe: Tools for Cleaning Rectangular Data

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 = .Machine$double.eps^0.5, 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: predicate-matrix, predicate-numeric, predicate-scalar, predicate-type, predicate-utils

arkhe documentation built on Nov. 17, 2023, 5:09 p.m.