File: rspWeave.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,419 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:
% 
%  xweavetangle.R
% 
% by the Rdoc compiler part of the R.oo package.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\name{rspWeave}
\alias{rspWeave}

\alias{asisWeave}

\title{A weave function for RSP documents}

\description{
 A weave function for RSP documents.
 This function is for RSP what \code{\link[utils]{Sweave}} is for Sweave documents.
}

\usage{
rspWeave(file, ..., postprocess=TRUE, clean=TRUE, quiet=FALSE, envir=new.env(),
  .engineName="rsp")
}

\arguments{
  \item{file}{The file to be weaved.}
  \item{...}{Not used.}
  \item{postprocess}{If \code{\link[base:logical]{TRUE}}, the compiled document is also post
    processed, if possible.}
  \item{clean}{If \code{\link[base:logical]{TRUE}}, intermediate files are removed, otherwise not.}
  \item{quiet}{If \code{\link[base:logical]{TRUE}}, no verbose output is generated.}
  \item{envir}{The \code{\link[base]{environment}} where the RSP document is
        parsed and evaluated.}
  \item{.engineName}{Internal only.}
}

\value{
  Returns the absolute pathname of the generated RSP product.
  The generated RSP product is postprocessed, if possible.
}

\author{Henrik Bengtsson}

\seealso{
  \code{\link{rspTangle}}()
}




\keyword{file}
\keyword{IO}
\keyword{internal}