check_environment: Check Environment

View source: R/environment.R

check_environmentR Documentation

Check Environment

Description

Checks if x is an environment.

Usage

check_environment(x, x_name = substitute(x), error = TRUE)

Arguments

x

The object to check.

x_name

A string of the name of the object x.

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).

Examples

check_environment(1, error = FALSE)
check_environment(.GlobalEnv, error = FALSE)

poissonconsulting/checkr documentation built on Oct. 18, 2023, 9:39 p.m.