checkmate (version 1.7.4)

checkFile: Check existence and access rights of files

Description

Check existence and access rights of files

Usage

checkFile(x, access = "", extension = NULL)
assertFile(x, access = "", extension = NULL, .var.name = vname(x),
  add = NULL)
assert_file(x, access = "", extension = NULL, .var.name = vname(x),
  add = NULL)
testFile(x, access = "", extension = NULL)
test_file(x, access = "", extension = NULL)
expect_file(x, access = "", extension = NULL, 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

extension

[character] Vector of allowed file extensions, matched case insensitive.

.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 return TRUE. If the check is not successful, assertFile/assert_file throws an error message, testFile/test_file returns FALSE, and checkFile returns a string with the error message. The function expect_file always returns an expectation.

See Also

Other filesystem: checkAccess, checkDirectory, checkPathForOutput

Examples

# Check if R's COPYING file is readable
testFile(file.path(R.home(), "COPYING"), access = "r")

# Check if R's COPYING file is readable and writable
testFile(file.path(R.home(), "COPYING"), access = "rw")