assert_integer_scalar {admiraldev} | R Documentation |
Is an Argument an Integer Scalar?
Description
Checks if an argument is an integer scalar
Usage
assert_integer_scalar(arg, subset = "none", optional = FALSE)
Arguments
arg |
A function argument to be checked |
subset |
A subset of integers that |
optional |
Is the checked argument optional? If set to |
Value
The function throws an error if arg
is not an integer belonging to the
specified subset
. Otherwise, the input is returned invisibly.
See Also
Checks for valid input and returns warning or errors messages:
assert_atomic_vector()
,
assert_character_scalar()
,
assert_character_vector()
,
assert_data_frame()
,
assert_date_vector()
,
assert_expr_list()
,
assert_expr()
,
assert_filter_cond()
,
assert_function()
,
assert_list_element()
,
assert_list_of()
,
assert_logical_scalar()
,
assert_named()
,
assert_numeric_vector()
,
assert_one_to_one()
,
assert_param_does_not_exist()
,
assert_s3_class()
,
assert_same_type()
,
assert_symbol()
,
assert_unit()
,
assert_vars()
,
assert_varval_list()
Examples
example_fun <- function(num1, num2) {
assert_integer_scalar(num1, subset = "positive")
assert_integer_scalar(num2, subset = "negative")
}
example_fun(1, -9)
try(example_fun(1.5, -9))
try(example_fun(2, 0))
try(example_fun("2", 0))