README.md

In decisionpatterns/ordering: Test, Check, Verify, Investigate the Monotonic Properties of Vectors

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) ordered
• increasing whether the values are in (strictly) increasing ordered
• decreasing whehter the values are in (strictly) decreasing ordered

In addition:

• is_constant whether all values are equal
• is_incremental whether x is incremental, ordered and equally spaced
• monotoniciy 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

decisionpatterns/ordering documentation built on May 5, 2019, 7:09 a.m.