File: preprocess.RspDocument.Rd

package info (click to toggle)
r-cran-r.rsp 0.45.0%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 2,568 kB
  • sloc: javascript: 612; tcl: 304; sh: 18; makefile: 16
file content (59 lines) | stat: -rw-r--r-- 1,890 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
55
56
57
58
59
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  RspDocument.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{preprocess.RspDocument}
\alias{preprocess.RspDocument}
\alias{RspDocument.preprocess}
\alias{preprocess,RspDocument-method}
\alias{RspDocument.parseIfElseDirectives}
\alias{parseIfElseDirectives.RspDocument}
\alias{parseIfElseDirectives,RspDocument-method}

\alias{parseIfElseDirectives}
\alias{RspDocument.parseCutNPasteDirectives}
\alias{parseCutNPasteDirectives.RspDocument}
\alias{parseCutNPasteDirectives,RspDocument-method}

\alias{parseCutNPasteDirectives}

\title{Processes all RSP preprocessing directives}

\description{
 Processes all RSP preprocessing directives.
}

\usage{
\method{preprocess}{RspDocument}(object, recursive=TRUE, flatten=TRUE, envir=parent.frame(),
  clipboard=new.env(), ..., verbose=FALSE)
}

\arguments{
  \item{recursive}{If \code{\link[base:logical]{TRUE}}, any \code{\link{RspDocument}}s introduced via
     preprocessing directives are recursively parsed and preprocessed
     as well.}
  \item{flatten}{If \code{\link[base:logical]{TRUE}}, any \code{\link{RspDocument}} introduced is
     replaced (inserted and expanded) by its \code{\link[base]{list}} of
     \code{\link{RspConstruct}}s.}
  \item{envir}{The \code{\link[base]{environment}} where the preprocessing is evaluated.}
  \item{clipboard}{An \code{\link[base]{environment}} hold cut'n'paste directives during
     preprocessing.}
  \item{...}{Not used.}
  \item{verbose}{See \code{\link[R.utils]{Verbose}}.}
}

\value{
 Returns an \code{\link{RspDocument}}.
}

\author{Henrik Bengtsson}

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