checkmate (version 1.6.1)

checkEnvironment: Check if an argument is an environment

Description

Check if an argument is an environment

Usage

checkEnvironment(x, contains = character(0L))
assertEnvironment(x, contains = character(0L), .var.name)
testEnvironment(x, contains = character(0L))
expect_environment(x, contains = character(0L), info = NULL, label = NULL)

Arguments

x

[any] Object to check.

contains

[character] Vector of object names expected in the environment. Defaults to character(0).

.var.name

[character(1)] Name for x. Defaults to a heuristic to determine the name using deparse and substitute.

info

[character(1)] Extra information to be included in the message for the testthat reporter. See expect_that.

label

[character(1)] Same as .var.name, but passed down to expect_that.

Value

• Depending on the function prefix: If the check is successful, all functions return TRUE. If the check is not successful, assertEnvironment throws an error message, testEnvironment returns FALSE, checkEnvironment returns a string with the error message. The function expect_environment will return an expectation.

See Also

Other basetypes: assertArray, checkArray, expect_array, testArray; assertAtomicVector, checkAtomicVector, expect_atomic_vector, testAtomicVector; assertAtomic, checkAtomic, expect_atomic, testAtomic; assertCharacter, checkCharacter, expect_character, testCharacter; assertComplex, checkComplex, expect_complex, testComplex; assertDataFrame, checkDataFrame, expect_data_frame, testDataFrame; assertFactor, checkFactor, expect_factor, testFactor; assertFunction, checkFunction, expect_function, testFunction; assertIntegerish, checkIntegerish, expect_integerish, testIntegerish; assertInteger, checkInteger, expect_integer, testInteger; assertList, checkList, expect_list, testList; assertLogical, checkLogical, expect_logical, testLogical; assertMatrix, checkMatrix, expect_matrix, testMatrix; assertNumeric, checkNumeric, expect_numeric, testNumeric; assertVector, checkVector, expect_vector, testVector

Examples

ee = as.environment(list(a = 1))
testEnvironment(ee)
testEnvironment(ee, contains = "a")