checkmate (version 1.8.1)

asInteger: Convert an argument to an integer

Description

asInteger is intended to be used for vectors while asInt is a specialization for scalar integers and asCount for scalar non-negative integers. Convertible are (a) atomic vectors with all elements NA and (b) double vectors with all elements being within tol range of an integer.

Usage

asInteger(x, ..., tol = sqrt(.Machine$double.eps), .var.name = vname(x), add = NULL)
asCount(x, na.ok = FALSE, positive = FALSE, tol = sqrt(.Machine$double.eps), .var.name = vname(x), add = NULL)
asInt(x, na.ok = FALSE, lower = -Inf, upper = Inf, tol = sqrt(.Machine$double.eps), .var.name = vname(x), add = NULL)

Arguments

x

[any] Object to convert.

...

[any] Additional arguments passed to assertIntegerish.

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 of the checked object to print in error messages. Defaults to the heuristic implemented in vname.

add

[AssertCollection] Collection to store assertions. See AssertCollection.

na.ok

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

positive

[logical(1)] Must x be positive (>= 1)? 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.

Value

Converted x.

Examples

asInteger(c(1, 2, 3))
asCount(1)
asInt(1)