1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/checkPathForOutput.R
\name{checkPathForOutput}
\alias{checkPathForOutput}
\alias{check_path_for_output}
\alias{assertPathForOutput}
\alias{assert_path_for_output}
\alias{testPathForOutput}
\alias{test_path_for_output}
\alias{expect_path_for_output}
\title{Check if a path is suited for creating an output file}
\usage{
checkPathForOutput(x, overwrite = FALSE, extension = NULL)
check_path_for_output(x, overwrite = FALSE, extension = NULL)
assertPathForOutput(
x,
overwrite = FALSE,
extension = NULL,
.var.name = vname(x),
add = NULL
)
assert_path_for_output(
x,
overwrite = FALSE,
extension = NULL,
.var.name = vname(x),
add = NULL
)
testPathForOutput(x, overwrite = FALSE, extension = NULL)
test_path_for_output(x, overwrite = FALSE, extension = NULL)
expect_path_for_output(
x,
overwrite = FALSE,
extension = NULL,
info = NULL,
label = vname(x)
)
}
\arguments{
\item{x}{[any]\cr
Object to check.}
\item{overwrite}{[\code{logical(1)}]\cr
If \code{TRUE}, an existing file in place is allowed if it
it is both readable and writable.
Default is \code{FALSE}.}
\item{extension}{[\code{character(1)}]\cr
Extension of the file, e.g. \dQuote{txt} or \dQuote{tar.gz}.}
\item{.var.name}{[\code{character(1)}]\cr
Name of the checked object to print in assertions. Defaults to
the heuristic implemented in \code{\link{vname}}.}
\item{add}{[\code{AssertCollection}]\cr
Collection to store assertion messages. See \code{\link{AssertCollection}}.}
\item{info}{[\code{character(1)}]\cr
Extra information to be included in the message for the testthat reporter.
See \code{\link[testthat]{expect_that}}.}
\item{label}{[\code{character(1)}]\cr
Name of the checked object to print in messages. Defaults to
the heuristic implemented in \code{\link{vname}}.}
}
\value{
Depending on the function prefix:
If the check is successful, the functions
\code{assertPathForOutput}/\code{assert_path_for_output} return
\code{x} invisibly, whereas
\code{checkPathForOutput}/\code{check_path_for_output} and
\code{testPathForOutput}/\code{test_path_for_output} return
\code{TRUE}.
If the check is not successful,
\code{assertPathForOutput}/\code{assert_path_for_output}
throws an error message,
\code{testPathForOutput}/\code{test_path_for_output}
returns \code{FALSE},
and \code{checkPathForOutput}/\code{check_path_for_output}
return a string with the error message.
The function \code{expect_path_for_output} always returns an
\code{\link[testthat]{expectation}}.
}
\description{
Check if a file path can be used safely to create a file and write to it.
This is checked:
\itemize{
\item{Does \code{dirname(x)} exist?}
\item{Does no file under path \code{x} exist?}
\item{Is \code{dirname(x)} writable?}
}
Paths are relative to the current working directory.
}
\examples{
# Can we create a file in the tempdir?
testPathForOutput(file.path(tempdir(), "process.log"))
}
\seealso{
Other filesystem:
\code{\link{checkAccess}()},
\code{\link{checkDirectoryExists}()},
\code{\link{checkFileExists}()}
}
\concept{filesystem}
|
