assert_whole_number: Assert that the input object is a whole number

In assertions: Simple Assertions for Beautiful and Customisable Error Messages

Assert that the input object is a whole number

Description

Check if x is a whole number (no decimal)

Usage

assert_whole_number(x, msg = NULL, call = rlang::caller_env(), arg_name = NULL)

Arguments

x	An object
msg	The error message thrown if the assertion fails (string)
call	Only relevant when pooling assertions into multi-assertion helper functions. See cli_abort for details.
arg_name	Advanced use only. Name of the argument passed (default: NULL, will automatically extract arg_name).

Value

invisible(TRUE) if x is a whole number, otherwise aborts with the error message specified by msg

Examples

try({
assert_whole_number(24) # Passes
assert_whole_number(2.5) # Throws error
})

assertions documentation built on April 3, 2025, 5:52 p.m.