is_increasing_vector: Checks if the passed entity is a vector of increasing...

In AstraZeneca/qscheck: qscheck

Checks if the passed entity is a vector of increasing numerical values.

Description

Checks if the passed entity is a vector of increasing numerical values.

Usage

is_increasing_vector(v, strictly = FALSE, allow_na_values = FALSE)

Arguments

v	The vector to check
strictly	boolean: If TRUE, only strictly increasing vectors will satisfy the test
allow_na_values	boolean: If TRUE, NA values are allowed in the vector and are considered as not existent. If FALSE, fails for vectors containing NAs.

Examples

## Not run: 
# For assertion
assertthat::assert_that(qscheck::is_increasing_vector(my_parameter))
# For check
if (qscheck::is_increasing_vector(my_parameter)) {}

## End(Not run)

AstraZeneca/qscheck documentation built on Nov. 1, 2023, 4:45 a.m.