R: Check if an argument is FALSE

checkFALSE {checkmate} | R Documentation

## Check if an argument is FALSE

### Description

Simply checks if an argument is `FALSE`.

### Usage

    checkFALSE(x, na.ok = FALSE)

    check_false(x, na.ok = FALSE)

    assertFALSE(x, na.ok = FALSE, .var.name = vname(x), add = NULL)

    assert_false(x, na.ok = FALSE, .var.name = vname(x), add = NULL)

    testFALSE(x, na.ok = FALSE)

    test_false(x, na.ok = FALSE)

### Arguments

`x` | [any] Object to check.
`na.ok` | [`logical(1)`] Are missing values allowed? Default is `FALSE`.
`.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`.

### Value

Depending on the function prefix: If the check is successful, the functions `assertFALSE.`/`assert_false.` return `x` invisibly, whereas `checkFALSE.`/`check_false.` and `testFALSE.`/`test_false.` return `TRUE`. If the check is not successful, `assertFALSE.`/`assert_false.` throws an error message, `testFALSE.`/`test_false.` returns `FALSE`, and `checkFALSE.` returns a string with the error message. The function `expect_false.` always returns an `expectation`.

### Examples

    testFALSE(FALSE)
    testFALSE(TRUE)

[Package checkmate version 1.9.4 Index]