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

\name{parseVignette}
\alias{parseVignette}


\title{Parses an Rnw file}

\description{
 Parses an Rnw file.
}

\usage{
parseVignette(pathname, commentPrefix="^[ \t]*\%[ \t]*", final=FALSE, source=FALSE,
  maxLines=-1L, ...)
}

\arguments{
  \item{pathname}{The Rnw file to be parsed.}
  \item{commentPrefix}{A regular expression specifying the prefix
    pattern of vignette comments.}
  \item{final}{If \code{\link[base:logical]{TRUE}}, the output PDF or HTML file is also located.}
  \item{source}{If \code{\link[base:logical]{TRUE}}, the output R source code file is also located.}
  \item{maxLines}{The maximum number of lines to scan.}
  \item{...}{Not used.}
}

\value{
  Returns a named \code{\link[base]{list}} or NULL if a non-vignette.
}

\author{Henrik Bengtsson}




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