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
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
%
% rcode.R
%
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\name{rcode}
\alias{rcode.default}
\alias{rcode}
\alias{rcode.RspString}
\alias{rcode.RspDocument}
\title{Compiles an RSP document and returns the generated source code script}
\description{
Compiles an RSP document and returns the generated source code script.
}
\usage{
\method{rcode}{default}(..., file=NULL, path=NULL, output=NULL, workdir=NULL, envir=parent.frame(),
args="*", verbose=FALSE)
}
\arguments{
\item{...}{\code{\link[base]{character}} strings with RSP markup.}
\item{file, path}{Alternatively, a file, a URL or a \code{\link[base:connections]{connection}} from
with the strings are read.
If a file, the \code{path} is prepended to the file, iff given.}
\item{output}{A \code{\link[base]{character}} string or a \code{\link[base:connections]{connection}} specifying where
output should be directed.
The default is a file with a filename where the file extension(s)
(typically \code{".*.rsp"}) has been replaced by \code{".R"}
in the directory given by the \code{workdir} argument.}
\item{workdir}{The working directory to use after parsing and
preprocessing.
If argument \code{output} specifies an absolute pathname,
then the directory of \code{output} is used, otherwise the
current directory is used.}
\item{envir}{The \code{\link[base]{environment}} in which the RSP string is
preprocessed and evaluated.}
\item{args}{A named \code{\link[base]{list}} of arguments assigned to the environment
in which the RSP string is parsed and evaluated.
See \code{\link[R.utils]{cmdArgs}}.}
\item{verbose}{See \code{\link[R.utils]{Verbose}}.}
}
\value{
Returns an \code{\link{RspFileProduct}} if possible,
otherwise an \code{\link{RspSourceCode}}.
}
\examples{
# RSP-embedded text to an R script
code <- rcode("Current time is <\%=Sys.time()\%>\n")
cat(code, sep="\n")
# RSP-embedded text to a shell script
code <- rcode("Current time is <\%=date\%>\n", language="sh")
cat(code, sep="\n")
}
\author{Henrik Bengtsson}
\seealso{
\code{\link{rcat}}() and \code{\link{rfile}}().
}
\keyword{file}
\keyword{IO}
\keyword{internal}
|
