Check Environment — chk_environment • chk

Checks if environment using

is.environment(x)

Usage

chk_environment(x, x_name = NULL)

vld_environment(x)

Arguments

x: The object to check.
x_name: A string of the name of object x or NULL.

Value

The chk_ function throws an informative error if the test fails or returns the original object if successful so it can used in pipes.

The vld_ function returns a flag indicating whether the test was met.

Functions

vld_environment(): Validate Environment

See also

is.environment()

For more details about the use of this function, please read the article vignette("chk-families").

Other data_type_checkers: chk_character(), chk_character_or_factor(), chk_complex(), chk_double(), chk_integer(), chk_logical(), chk_numeric(), chk_raw()

Examples

# chk_environment
chk_environment(.GlobalEnv)
try(chk_environment(1))
#> Error in eval(expr, envir) : `1` must be an environment.
# vld_environment
vld_environment(1)
#> [1] FALSE
vld_environment(list(1))
#> [1] FALSE
vld_environment(.GlobalEnv)
#> [1] TRUE
vld_environment(environment())
#> [1] TRUE