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

\name{parseVignettes}
\alias{parseVignettes}


\title{Locates and parses all vignettes}

\description{
 Locates and parses all vignettes.
}

\usage{
parseVignettes(path=".", pattern="[.][^.~]*$", ..., drop="^dummy.tex$")
}

\arguments{
  \item{path}{The directory where to search for vignettes.}
  \item{pattern}{Filename pattern to locate vignettes.}
  \item{...}{Additional arguments passed to \code{\link{parseVignette}}().}
  \item{drop}{A \code{\link[base]{vector}} of filename patterns of vignette sources
   to be ignored.}
}

\value{
  Returns a \code{\link[base]{list}} where each element corresponds to an
  identified vignette source file.  A file is considered to be
  a vignette source file if it has \code{\\Vignette.*\{\}} markups
  in the top 50 lines.
  Each such vignette element consists of a named \code{\link[base]{list}} with
  the parse \code{\\Vignette.*\{\}} information.
}

\author{Henrik Bengtsson}




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