checkmate (version 1.6.1)

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 = "", .var.name)
testDirectory(x, access = "", .var.name)
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

.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, assertDirectory throws an error message, testDirectory returns FALSE, checkDirectory returns a string with the error message. The function expect_directory will return an expectation.

See Also

Other filesystem: assertAccess, checkAccess, expect_access, testAccess; assertFile, checkFile, expect_file, testFile; assertPathForOutput, checkPathForOutput, expect_path_for_output, testPathForOutput

Examples

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

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