Description
Test, Check, Verify, Investigate the Monotonic Properties of Vectors.
Description
Functions to test/check/verify/investigate the ordering of vectors. The 'is_[strictly_]*' family of functions test vectors for 'sorted', 'monotonic', 'increasing', 'decreasing' order; 'is_constant' and 'is_incremental' test for the degree of ordering. `ordering` provides a numeric indication of ordering -2 (strictly decreasing) to 2 (strictly increasing).
README.md
ordering
Test/Check/Verify/Investigate the Ordering of Vectors
ordering provides several functions for testing/checking/verify/investigating the ordering of vectors (numeric or otherwise).
The packages has the following tests:
is_[strictly_]*
Where *
can be one of:
monotonic
-or-sorted
whether the values are (strictly) orderedincreasing
whether the values are in (strictly) increasing ordereddecreasing
whehter the values are in (strictly) decreasing ordered
In addition:
is_constant
whether all values are equalis_incremental
whether x is incremental, ordered and equally spacedmonotoniciy
reports the degree of monotonicty.
install
Install using the standard methods
install.packages('ordering')
# -OR-
devtools::install_github( "decisionpatterns/ordering")
Usage
The usage of the packages is probably best demonstrated by a few examples:
x <- 1:5
is_sorted(x) # TRUE
is_strictly_sorted(x) # TRUE
is_increasing(x) # TRUE
is_strictly_increasing(x) # TRUE
is_decreasing(x) # FALSE
is_strictly_decreasing(x) # FALSE
is_sorted(x) # TRUE
is_strictly_sorted(x) # TRUE
is_constant(x) # FALSE
is_incremental() # TRUE
monotonicity(x) # 2 - strictly increasing