File: popTemporaryFile.Rd

package info (click to toggle)
r-cran-r.utils 2.13.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,864 kB
  • sloc: sh: 18; makefile: 6
file content (58 lines) | stat: -rw-r--r-- 1,833 bytes parent folder | download | duplicates (5)
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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  popTemporaryFile.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

 \name{popTemporaryFile}
\alias{popTemporaryFile.default}
\alias{popTemporaryFile}

 \title{Drops a temporary suffix from the temporary pathname}

 \usage{
\method{popTemporaryFile}{default}(filename, path=NULL, suffix=".tmp", isFile=TRUE, ..., verbose=FALSE)
}

 \description{
  Drops a temporary suffix from the temporary pathname and, by default, renames an existing temporary file
  accordingly.
 }

 \arguments{
   \item{filename}{The filename of the temporary file.}
   \item{path}{The path of the temporary file.}
   \item{suffix}{The suffix of the temporary filename to be dropped.}
   \item{isFile}{If \code{\link[base:logical]{TRUE}}, the temporary file must exist and
      will be renamed.  If \code{\link[base:logical]{FALSE}}, it is only the pathname string
      that will be modified. For details, see below.}
   \item{...}{Not used.}
   \item{verbose}{A \code{\link[base]{logical}} or \code{\link{Verbose}}.}
 }

 \value{
   Returns the pathname with the temporary suffix dropped.
 }

 \details{
   If \code{isFile} is \code{\link[base:logical]{FALSE}}, the pathname where the suffix of the
   temporary pathname has been dropped is returned.
   If \code{isFile} is \code{\link[base:logical]{TRUE}}, the temporary file is renamed.
   Then, if the temporary file does not exists or it was not successfully
   renamed, an exception is thrown.
 }

 \author{Henrik Bengtsson}

 \seealso{
  See \code{\link{pushTemporaryFile}}() for more details and an example.
 }




\keyword{utilities}
\keyword{programming}
\keyword{IO}