File: evaluate.RspShSourceCode.Rd

package info (click to toggle)
r-cran-r.rsp 0.46.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,472 kB
  • sloc: javascript: 612; tcl: 304; sh: 18; makefile: 16
file content (54 lines) | stat: -rw-r--r-- 1,804 bytes parent folder | download | duplicates (2)
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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  RspShSourceCode.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{evaluate.RspShSourceCode}
\alias{evaluate.RspShSourceCode}
\alias{RspShSourceCode.evaluate}
\alias{evaluate,RspShSourceCode-method}
\alias{RspShSourceCode.findProcessor}
\alias{findProcessor.RspShSourceCode}
\alias{findProcessor,RspShSourceCode-method}


\title{Evaluates the shell (sh) code}

\description{
 Evaluates the shell (sh) code.
}

\usage{
\method{evaluate}{RspShSourceCode}(object, envir=parent.frame(), args="*", output=c("RspStringProduct", "stdout"),
  ..., verbose=FALSE)
}

\arguments{
  \item{envir}{The \code{\link[base]{environment}} in which the RSP string is 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{output}{A \code{\link[base]{character}} string specifying how the RSP output
    should be handled/returned.}
  \item{...}{Optional arguments passed to \code{\link[base]{eval}}().}
}

\value{
 If \code{output="stdout"}, then \code{\link[base]{NULL}} is returned and the RSP output
 is sent to the standard output.
 Note that this is output is "buffered", meaning it will be sent to
 standard output upon completion.  This is a limitation of R.
 If \code{output="RspStringProduct"}, then the output is captured
 and returned as an \code{\link{RspStringProduct}} with attributes set.
}

\author{Henrik Bengtsson}

\seealso{
  For more information see \code{\link{RspShSourceCode}}.
}
\keyword{internal}
\keyword{methods}