checkmate (version 1.7.2)

checkDirectory: Check for existence and access rights of directories

Description

Check for existence and access rights of directories

Usage

checkDirectory(x, access = "")
assertDirectory(x, access = "", add = NULL, .var.name)
assert_directory(x, access = "", add = NULL, .var.name)
testDirectory(x, access = "")
test_directory(x, access = "")
expect_directory(x, access = "", info = NULL, label = NULL)

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

add

[AssertCollection] Collection to store assertions. See AssertCollection.

.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, the functions return TRUE. If the check is not successful, assertDirectory/assert_directory throws an error message, testDirectory/test_directory returns FALSE, and checkDirectory returns a string with the error message. The function expect_directory always returns an expectation.

See Also

Other filesystem: checkAccess, checkFile, checkPathForOutput

Examples

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

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