File: parseDocument.RspParser.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 (48 lines) | stat: -rw-r--r-- 1,518 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
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Do not modify this file since it was automatically generated from:
% 
%  RspParser.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{parseDocument.RspParser}
\alias{parseDocument.RspParser}
\alias{RspParser.parseDocument}
\alias{parseDocument,RspParser-method}

\title{Parse an RSP string into and RSP document}

\description{
 Parse an RSP string into and RSP document with RSP comments dropped.
}

\usage{
\method{parseDocument}{RspParser}(parser, object, envir=parent.frame(), ...,
  until=c("*", "end", "expressions", "directives", "comments"),
  as=c("RspDocument", "RspString"), verbose=FALSE)
}

\arguments{
  \item{object}{An \code{\link{RspString}} to be parsed.}
  \item{envir}{The \code{\link[base]{environment}} where the RSP document is preprocessed.}
  \item{...}{Passed to the processor in each step.}
  \item{until}{Specifies how far the parse should proceed, which is useful
     for troubleshooting and debugging.}
  \item{as}{Specifies in what format the parsed RSP document
     should be returned.}
  \item{verbose}{See \code{\link[R.utils]{Verbose}}.}
}

\value{
 Returns a \code{\link{RspDocument}} (when \code{as = "RspDocument"}; default)
 or \code{\link{RspString}} (when \code{as = "RspString"}).
}

\author{Henrik Bengtsson}

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