checkDirectory {checkmate}R Documentation

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)

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 for x. Defaults to a heuristic to determine the name using deparse and substitute.

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 and checkDirectory returns a string with the error message.

See Also

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

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.6.0 Index]