checkmate (version 1.6.1)

checkCount: Check if an argument is a count

Description

A count is defined as non-negative integerish value.

Usage

checkCount(x, na.ok = FALSE, positive = FALSE,
  tol = sqrt(.Machine$double.eps))
assertCount(x, na.ok = FALSE, positive = FALSE,
  tol = sqrt(.Machine$double.eps), .var.name)
testCount(x, na.ok = FALSE, positive = FALSE,
  tol = sqrt(.Machine$double.eps))
expect_count(x, na.ok = FALSE, positive = FALSE,
  tol = sqrt(.Machine$double.eps), info = NULL, label = NULL)

Arguments

x

[any] Object to check.

na.ok

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

positive

[logical(1)] Must x be positive (>= 1)? Default is FALSE, allowing 0.

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.

info

[character(1)] Extra information to be included in the message for the testthat reporter. See expect_that.

label

[character(1)] Same as .var.name, but passed down to expect_that.

Value

• Depending on the function prefix: If the check is successful, all functions return TRUE. If the check is not successful, assertCount throws an error message, testCount returns FALSE, checkCount returns a string with the error message. The function expect_count will return an expectation.

Details

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

See Also

Other scalars: assertFlag, checkFlag, expect_flag, testFlag; assertInt, checkInt, expect_int, testInt; assertNumber, checkNumber, expect_number, testNumber; assertPercentage, checkPercentage, expect_percentage, testPercentage; assertScalarNA, checkScalarNA, expect_scalar_na, testScalarNA; assertScalar, checkScalar, expect_scalar, testScalar; assertString, checkString, expect_string, testString

Examples

testCount(1)
testCount(-1)