assertive (version 0.2-1)

assert_all_are_in_closed_range: Is the input in range?

Description

Checks to see if the input is within an numeric interval.

Usage

assert_all_are_in_closed_range(x, lower = -Inf, upper = Inf)

assert_any_are_in_closed_range(x, lower = -Inf, upper = Inf)

assert_all_are_in_left_open_range(x, lower = -Inf, upper = Inf)

assert_any_are_in_left_open_range(x, lower = -Inf, upper = Inf)

assert_all_are_in_open_range(x, lower = -Inf, upper = Inf)

assert_any_are_in_open_range(x, lower = -Inf, upper = Inf)

assert_all_are_in_range(x, lower = -Inf, upper = Inf,
  lower_is_strict = FALSE, upper_is_strict = FALSE)

assert_any_are_in_range(x, lower = -Inf, upper = Inf,
  lower_is_strict = FALSE, upper_is_strict = FALSE)

assert_all_are_in_right_open_range(x, lower = -Inf, upper = Inf)

assert_any_are_in_right_open_range(x, lower = -Inf, upper = Inf)

assert_all_are_negative(x)

assert_any_are_negative(x)

assert_all_are_non_negative(x)

assert_any_are_non_negative(x)

assert_all_are_non_positive(x)

assert_any_are_non_positive(x)

assert_all_are_percentages(x, lower_is_strict = FALSE,
  upper_is_strict = FALSE)

assert_any_are_percentages(x, lower_is_strict = FALSE,
  upper_is_strict = FALSE)

assert_all_are_positive(x)

assert_any_are_positive(x)

assert_all_are_proportions(x, lower_is_strict = FALSE,
  upper_is_strict = FALSE)

assert_any_are_proportions(x, lower_is_strict = FALSE,
  upper_is_strict = FALSE)

is_in_closed_range(x, lower = -Inf, upper = Inf)

is_in_left_open_range(x, lower = -Inf, upper = Inf)

is_in_open_range(x, lower = -Inf, upper = Inf)

is_in_range(x, lower = -Inf, upper = Inf, lower_is_strict = FALSE,
  upper_is_strict = FALSE)

is_in_right_open_range(x, lower = -Inf, upper = Inf)

is_negative(x)

is_non_negative(x)

is_non_positive(x)

is_percentage(x, lower_is_strict = FALSE, upper_is_strict = FALSE)

is_positive(x)

is_proportion(x, lower_is_strict = FALSE, upper_is_strict = FALSE)

Arguments

x

Input to check.

lower

Lower bound for the interval.

upper

Upper bound for the interval.

lower_is_strict

If TRUE, the lower bound is open (strict) otherwise it is closed.

upper_is_strict

If TRUE, the upper bound is open (strict) otherwise it is closed.

Value

• The is_* function return TRUE if the input is within an interval. The assert_* functions return nothing but throw an error if the corresponding is_* function returns FALSE.

Examples

assert_all_are_positive(1:10)
assert_all_are_non_negative(0:10)
assert_any_are_positive(c(-1, 1))
assert_all_are_percentages(c(0, 50, 100))
assert_all_are_proportions(c(0, 0.5, 1))
assert_all_are_in_left_open_range(1 + .Machine$double.eps, lower = 1)