# Test, Check, Verify, Investigate the Monotonic Properties of Vectors

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).

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

• `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
``````

# monotone 0.4.1

• Add is_strictly_sorted as alias for is_strictly_monotonic
• Fix docs

# monotone 0.4.0

• Break apart code into smaller files
• Fix spelling monotonoc

# monotone 0.3.0

• Added a `NEWS.md` file to track changes to the package.
• Fixed documentation

# Reference manual

install.packages("ordering")

0.7.0 by Christopher Brown, 2 years ago

https://github.com/decisionpatterns/ordering

Report a bug at https://github.com/decisionpatterns/ordering/issues

Browse source code at https://github.com/cran/ordering

Authors: Christopher Brown [aut, cre] , Decision Patterns [cph]

Documentation:   PDF Manual