R: Check file path for later output

checkPathForOutput {checkmate}

R Documentation

Check file path for later output

Description

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

This is checked:

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

Paths are relative to the current working directory.

Usage

checkPathForOutput(x, overwrite = FALSE)

assertPathForOutput(x, overwrite = FALSE, .var.name)

testPathForOutput(x, overwrite = FALSE)

Arguments

`x`	[any] Object to check.
`overwrite`	[`logical(1)`] If `TRUE`, an exising file in place is allowed if it it is both readable and writeable. Default is `FALSE`.
`.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, assertPathForOutput throws an error message, testPathForOutput returns FALSE and checkPathForOutput returns a string with the error message.

Examples

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