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

\name{rargs}
\alias{rargs.default}
\alias{rargs}

\title{Gets RSP arguments of an RSP document}

\description{
 Gets RSP arguments of an RSP document, if any.
}

\usage{
\method{rargs}{default}(...)
}

\arguments{
  \item{...}{Arguments passed to \code{\link{rcompile}}().}
}

\value{
  Returns a \code{\link[base]{data.frame}} of class 'RspArguments'.
}

\details{
  Any RSP preprocessing variable with an 'description' attribute
  is considered to be an RSP argument.
}

\examples{
path <- system.file("rsp_examples", package="R.rsp")
args <- rargs(file="LoremIpsum.tex.rsp", path=path)
print(args)


}

\author{Henrik Bengtsson}

\seealso{
 \code{\link{rfile}}().
}




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