R: Check if an argument is an environment

checkEnvironment {checkmate} | R Documentation

## Check if an argument is an environment

### Description

Check if an argument is an environment

### Usage

    checkEnvironment(x, contains = character(0L), null.ok = FALSE)

    check_environment(x, contains = character(0L), null.ok = FALSE)

    assertEnvironment(
      x,
      contains = character(0L),
      null.ok = FALSE,
      .var.name = vname(x),
      add = NULL
    )

    assert_environment(
      x,
      contains = character(0L),
      null.ok = FALSE,
      .var.name = vname(x),
      add = NULL
    )

    testEnvironment(x, contains = character(0L), null.ok = FALSE)

    test_environment(x, contains = character(0L), null.ok = FALSE)

    expect_environment(
      x,
      contains = character(0L),
      null.ok = FALSE,
      info = NULL,
      label = vname(x)
    )

### Arguments

`x` | [any] Object to check.
`contains` | [`character`] Vector of object names expected in the environment. Defaults to `character(0)`.
`null.ok` | [`logical(1)`] If set to `TRUE`, `x` may also be `NULL`. In this case only a type check of `x` is performed, all additional checks are disabled.
`.var.name` | [`character(1)`] Name of the checked object to print in assertions. Defaults to the heuristic implemented in `vname`.
`add` | [`AssertCollection`] Collection to store assertion messages. See `AssertCollection`.
`info` | [`character(1)`] Extra information to be included in the message for the testthat reporter. See `expect_that`.
`label` | [`character(1)`] Name of the checked object to print in messages. Defaults to the heuristic implemented in `vname`.

### Value

Depending on the function prefix: If the check is successful, the functions `assertEnvironment`/`assert_environment` return `x` invisibly, whereas `checkEnvironment`/`check_environment` and `testEnvironment`/`test_environment` return `TRUE`. If the check is not successful, `assertEnvironment`/`assert_environment` throws an error message, `testEnvironment`/`test_environment` returns `FALSE`, and `checkEnvironment`/`check_environment` return a string with the error message. The function `expect_environment` always returns an `expectation`.

### See Also

Other basetypes: `checkArray()`, `checkAtomicVector()`, `checkAtomic()`, `checkCharacter()`, `checkComplex()`, `checkDataFrame()`, `checkDate()`, `checkDouble()`, `checkFactor()`, `checkFormula()`, `checkFunction()`, `checkIntegerish()`, `checkInteger()`, `checkList()`, `checkLogical()`, `checkMatrix()`, `checkNull()`, `checkNumeric()`, `checkPOSIXct()`, `checkRaw()`, `checkVector()`

### Examples

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

[Package checkmate version 2.1.0 Index]