R: Check for existence and access rights of directories

checkDirectoryExists {checkmate} | R Documentation

## Check for existence and access rights of directories

### Description

Check for existence and access rights of directories

### Usage

    checkDirectoryExists(x, access = "")

    check_directory_exists(x, access = "")

    assertDirectoryExists(x, access = "", .var.name = vname(x), add = NULL)

    assert_directory_exists(x, access = "", .var.name = vname(x), add = NULL)

    testDirectoryExists(x, access = "")

    test_directory_exists(x, access = "")

    expect_directory_exists(x, access = "", info = NULL, label = vname(x))

    checkDirectory(x, access = "")

    assertDirectory(x, access = "", .var.name = vname(x), add = NULL)

    assert_directory(x, access = "", .var.name = vname(x), add = NULL)

    testDirectory(x, access = "")

    test_directory(x, access = "")

    expect_directory(x, access = "", info = NULL, label = vname(x))

### Arguments

`x` | [any] Object to check.
`access` | [`character(1)`] Single string containing possible characters ‘r’, ‘w’ and ‘x’ to force a check for read, write or execute access rights, respectively. Write and executable rights are not checked on Windows.
`.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 `assertDirectoryExists`/`assert_directory_exists` return `x` invisibly, whereas `checkDirectoryExists`/`check_directory_exists` and `testDirectoryExists`/`test_directory_exists` return `TRUE`. If the check is not successful, `assertDirectoryExists`/`assert_directory_exists` throws an error message, `testDirectoryExists`/`test_directory_exists` returns `FALSE`, and `checkDirectoryExists` returns a string with the error message. The function `expect_directory_exists` always returns an `expectation`.

### Note

The functions without the suffix “exists” are deprecated and will be removed from the package in a future version due to name clashes.

### See Also

Other filesystem: `checkAccess`, `checkFileExists`, `checkPathForOutput`

### Examples

    # Is R's home directory readable?
    testDirectory(R.home(), "r")

    # Is R's home directory readable and writable?
    testDirectory(R.home(), "rw")

[Package checkmate version 1.8.2 Index]