predicate-trend {arkhe}R Documentation

Numeric Trend Predicates

Description

Check numeric objects:

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


[Package arkhe version 1.0.0 Index]