checkmate (version 1.7.2)

checkPathForOutput: Check if a path is suited for creating an output file

Description

Check if a file path can be safely be used to create a file and write to it.

This is checked:

• Doesdirname(x)exist?

Does no file under path x exist? Is dirname(x) writeable?

Usage

checkPathForOutput(x, overwrite = FALSE)
assertPathForOutput(x, overwrite = FALSE, add = NULL, .var.name)
assert_path_for_output(x, overwrite = FALSE, add = NULL, .var.name)
testPathForOutput(x, overwrite = FALSE)
test_path_for_output(x, overwrite = FALSE)
expect_path_for_output(x, overwrite = FALSE, info = NULL, label = NULL)

Arguments

x

[any] Object to check.

overwrite

[logical(1)] If TRUE, an existing file in place is allowed if it it is both readable and writeable. Default is FALSE.

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, assertPathForOutput/assert_path_for_output throws an error message, testPathForOutput/test_path_for_output returns FALSE, and checkPathForOutput returns a string with the error message. The function expect_path_for_output always returns an expectation.

See Also

Other filesystem: checkAccess, checkDirectory, checkFile

Examples

# Can we create a file in the tempdir?
testPathForOutput(file.path(tempdir(), "process.log"))