checkInt {checkmate}R Documentation

Check if an argument is a single integerish value

Description

Check if an argument is a single integerish value

Usage

checkInt(x, na.ok = FALSE, lower = -Inf, upper = Inf,
  tol = sqrt(.Machine$double.eps))

assertInt(x, na.ok = FALSE, lower = -Inf, upper = Inf,
  tol = sqrt(.Machine$double.eps), .var.name)

testInt(x, na.ok = FALSE, lower = -Inf, upper = Inf,
  tol = sqrt(.Machine$double.eps))

Arguments

x

[any]
Object to check.

na.ok

[logical(1)]
Are missing values allowed? Default is FALSE.

lower

[numeric(1)]
Lower value all elements of x must be greater than.

upper

[numeric(1)]
Upper value all elements of x must be lower than.

tol

[double(1)]
Numerical tolerance used to check whether a double or complex can be converted. Default is sqrt(.Machine$double.eps).

.var.name

[character(1)]
Name for x. Defaults to a heuristic to determine the name using deparse and substitute.

Details

This function does not distinguish between NA, NA_integer_, NA_real_, NA_complex_ NA_character_ and NaN.

Value

Depending on the function prefix: If the check is successful, all functions return TRUE. If the check is not successful, assertInt throws an error message, testInt returns FALSE and checkInt returns a string with the error message.

See Also

Other scalars: assertCount, checkCount, testCount; assertFlag, checkFlag, testFlag; assertNumber, checkNumber, testNumber; assertPercentage, checkPercentage, testPercentage; assertScalarNA, checkScalarNA, testScalarNA; assertScalar, checkScalar, testScalar; assertString, checkString, testString

Examples

testInt(1)
testInt(-1, lower = 0)
[Package checkmate version 1.6.0 Index]