checkmate (version 1.7.2)

checkAccess: Check file system access rights

Description

Check file system access rights

Usage

checkAccess(x, access = "")
assertAccess(x, access = "", add = NULL, .var.name)
assert_access(x, access = "", add = NULL, .var.name)
testAccess(x, access = "")
test_access(x, access = "")
expect_access(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, assertAccess/assert_access throws an error message, testAccess/test_access returns FALSE, and checkAccess returns a string with the error message. The function expect_access always returns an expectation.

See Also

Other filesystem: checkDirectory, checkFile, checkPathForOutput

Examples

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

# Is R's home directory writeable?
testAccess(R.home(), "w")