checkNumber {checkmate}R Documentation

Check if an argument is a single numeric

Description

Check if an argument is a single numeric

Usage

checkNumber(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE)

assertNumber(x, na.ok = FALSE, lower = -Inf, upper = Inf,
  finite = FALSE, .var.name)

testNumber(x, na.ok = FALSE, lower = -Inf, upper = Inf, finite = FALSE)

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.

finite

[logical(1)]
Check for only finite values? Default is FALSE.

.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, assertNumber throws an error message, testNumber returns FALSE and checkNumber returns a string with the error message.

See Also

Other scalars: assertCount, checkCount, testCount; assertFlag, checkFlag, testFlag; assertInt, checkInt, testInt; assertPercentage, checkPercentage, testPercentage; assertScalarNA, checkScalarNA, testScalarNA; assertScalar, checkScalar, testScalar; assertString, checkString, testString

Examples

testNumber(1)
testNumber(1:2)
[Package checkmate version 1.6.0 Index]