The R Project SVN R

Rev

Rev 68948 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

Rev 68948 Rev 75378
Line 6... Line 6...
6 
\name{Rdutils}
 6 
\name{Rdutils}
7 
\alias{Rd_db}
 7 
\alias{Rd_db}
8 
\title{Rd Utilities}
 8 
\title{Rd Utilities}
9 
\description{Utilities for computing on the information in Rd objects.}
 9 
\description{Utilities for computing on the information in Rd objects.}
10 
\usage{
 10 
\usage{
11 
Rd_db(package, dir, lib.loc = NULL)
 11 
Rd_db(package, dir, lib.loc = NULL, stages = "build")
12 
}
 12 
}
13 
\arguments{
 13 
\arguments{
14 
  \item{package}{a character string naming an installed package.}
 14 
  \item{package}{a character string naming an installed package.}
15 
  \item{dir}{a character string specifying the path to a package's root
 15 
  \item{dir}{a character string specifying the path to a package's root
16 
    source directory.  This should contain the subdirectory \file{man}
 16 
    source directory.  This should contain the subdirectory \file{man}
Line 18... Line 18...
18 
    \code{package} is not given.}
 18 
    \code{package} is not given.}
19 
  \item{lib.loc}{a character vector of directory names of \R libraries,
 19 
  \item{lib.loc}{a character vector of directory names of \R libraries,
20 
    or \code{NULL}.  The default value of \code{NULL} corresponds to all
 20 
    or \code{NULL}.  The default value of \code{NULL} corresponds to all
21 
    libraries currently known.  The specified library trees are used to
 21 
    libraries currently known.  The specified library trees are used to
22 
    search for \code{package}.}
 22 
    search for \code{package}.}
- 
 
 23 
  \item{stages}{if \code{dir} is specified and the database is being
- 
 
 24 
    built from source, which stages of \verb{\Sexpr} processing should be
- 
 
 25 
    processed?}
23 
}
 26 
}
24 
\details{
 27 
\details{
25 
  \code{Rd_db} builds a simple database of all Rd objects in a package,
 28 
  \code{Rd_db} builds a simple database of all Rd objects in a package,
26 
  as a list of the results of running \code{\link{parse_Rd}} on the Rd
 29 
  as a list of the results of running \code{\link{parse_Rd}} on the Rd
27 
  source files in the package and processing platform conditionals.
 30 
  source files in the package and processing platform conditionals
- 
 
 31 
  and some \verb{\Sexpr} macros.
28 
}
 32 
}
29 
\seealso{
 33 
\seealso{
30 
  \code{\link{parse_Rd}}
 34 
  \code{\link{parse_Rd}}
31 
}
 35 
}
32 
\examples{\donttest{
 36 
\examples{\donttest{