chk (version 0.2.0)

chk_range: Check/Validate Range

Description

Checks/validates range of non-missing values.

Usage

chk_range(x, range = c(0, 1), x_name = NULL)
vld_range(x, range = c(0, 1))
chk_lt(x, value = 0, x_name = NULL)
vld_lt(x, value = 0)
chk_lte(x, value = 0, x_name = NULL)
vld_lte(x, value = 0)
chk_gt(x, value = 0, x_name = NULL)
vld_gt(x, value = 0)
chk_gte(x, value = 0, x_name = NULL)
vld_gte(x, value = 0)

Arguments

x

The object to check.

range

A vector of length 2 of the lower and upper permitted values.

x_name

A string of the name of object x or NULL.

value

A non-missing scalar of a value.

Value

The chk_ functions throw an informative error if the test fails. The vld_ functions return a flag indicating whether the test was met.

Functions

• chk_range: Check Range

  Checks if all non-missing values fall within range using vld_range().

• vld_range: Validate Range

  Validates all non-missing values fall within range using

  all(x[!is.na(x)] >= range[1] & x[!is.na(x)] <= range[2])

  Range should be a non-missing sorted vector of length 2.

• chk_lt: Check Less Than

  Checks if all non-missing values are less than value using vld_lt().

• vld_lt: Validate Less Than

  Validates all non-missing values are less than value using

  all(x[!is.na(x)] < value))

  value should be a non-missing scalar.

• chk_lte: Check Less Than or Equal To

  Checks if all non-missing values are less than or equal to y using vld_lte().

• vld_lte: Validate Less Than or Equal To

  Validates all non-missing values are less than or equal to y using

  all(x[!is.na(x)] <= value))

  value should be a non-missing scalar.

• chk_gt: Check Greater Than

  Checks if all non-missing values are greater than value using vld_gt().

• vld_gt: Validate Greater Than

  Validates all non-missing values are greater than value using

  all(x[!is.na(x)] > value)).

  value should be a non-missing scalar.

• chk_gte: Check Greater Than or Equal To

  Checks if all non-missing values are greater than or equal to y using vld_gte().

• vld_gte: Validate Greater Than or Equal To

  Validates all non-missing values are greater than or equal to y using:

  all(x[!is.na(x)] >= value)).

  value should be a non-missing scalar.

Examples

# NOT RUN {
# chk_range
chk_range(0)
try(chk_range(-0.1))

# vld_range
vld_range(numeric(0))
vld_range(0)
vld_range(-0.1)
vld_range(c(0.1, 0.2, NA))
vld_range(c(0.1, 0.2, NA), range = c(0, 1))

# chk_lt
chk_lt(-0.1)
try(chk_lt(c(-0.1, 0.2)))

# vld_lt
vld_lt(numeric(0))
vld_lt(0)
vld_lt(-0.1)
vld_lt(c(-0.1, -0.2, NA))
vld_lt(c(-0.1, 0.2))
vld_lt(c(-0.1, 0.2), value = 1)
vld_lt("a", value = "b")

# chk_lte
chk_lte(0)
try(chk_lte(0.1))

# vld_lte
vld_lte(numeric(0))
vld_lte(0)
vld_lte(0.1)
vld_lte(c(-0.1, -0.2, NA))
vld_lte(c(-0.1, -0.2, NA), value = -1)

# chk_gt
chk_gt(0.1)
try(chk_gt(c(0.1, -0.2)))

# vld_gt
vld_gt(numeric(0))
vld_gt(0)
vld_gt(0.1)
vld_gt(c(0.1, 0.2, NA))
vld_gt(c(0.1, -0.2))
vld_gt(c(-0.1, 0.2), value = -1)
vld_gt("b", value = "a")

# chk_gte
chk_gte(0)
try(chk_gte(-0.1))

# vld_gte
vld_gte(numeric(0))
vld_gte(0)
vld_gte(-0.1)
vld_gte(c(0.1, 0.2, NA))
vld_gte(c(0.1, 0.2, NA), value = 1)
# }