check_scalar: Check Scalar

In checkr: Check the Properties of Common R Objects

Description

Checks whether an object is an atomic vector with one element.

Usage

check_scalar(x, values = NULL, named = FALSE, attributes = named,
  only = FALSE, x_name = substitute(x), error = TRUE)

Arguments

x	The object to check.
values	NULL or a vector specifying the values.
named	A flag indicating whether the scalar must be named or unnamed or NA if it doesn't matter if the scalar is named.
attributes	A flag indicating whether the scalar must or must not have attributes or NA if it doesn't matter if the scalar is named.
only	A flag indicating whether only the actual values are permitted. It only affects values with two or less non-missing elements.
x_name	A string of the name of the object.
error	A flag indicating whether to throw an informative error or immediately generate an informative message if the check fails.

Value

An invisible copy of x (if it doesn't throw an error).

See Also

check_vector

Examples

check_scalar(1)
check_scalar(c(1,2), error = FALSE)
check_scalar(1, c(2,3), error = FALSE)

checkr documentation built on May 1, 2019, 6:59 p.m.