The R Project SVN R

Rev

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

Rev 23030 Rev 27370
Line 1... Line 1...
1 
\name{Rdindex}
 1 
\name{Rdindex}
2 
\title{Generate Index from Rd Files}
 2 
\title{Generate Index from Rd Files}
3 
\alias{Rdindex}
 3 
\alias{Rdindex}
4 
\description{
 4 
\description{
5 
  Print a 2-column index table with names and titles from given R
 5 
  Print a 2-column index table with \dQuote{names} and titles from given
6 
  documentation files to a given output file or connection.  The titles
 6 
  R documentation files to a given output file or connection.  The
7 
  are nicely formatted between two column positions (typically 25 and
 7 
  titles are nicely formatted between two column positions (typically 25
8 
  72, respectively).
 8 
  and 72, respectively).
9 
}
 9 
}
10 
\usage{
 10 
\usage{
11 
Rdindex(RdFiles, outFile = "", type = NULL,
 11 
Rdindex(RdFiles, outFile = "", type = NULL,
12 
        width = 0.9 * getOption("width"), indent = NULL)
 12 
        width = 0.9 * getOption("width"), indent = NULL)
13 
}
 13 
}
Line 27... Line 27...
27 
    lines in the output.}
 27 
    lines in the output.}
28 
  \item{indent}{a positive integer specifying the indentation of the
 28 
  \item{indent}{a positive integer specifying the indentation of the
29 
    second column.  Must not be greater than \code{width/2}, and
 29 
    second column.  Must not be greater than \code{width/2}, and
30 
    defaults to \code{width/3}.}
 30 
    defaults to \code{width/3}.}
31 
}
 31 
}
- 
 
 32 
\details{
- 
 
 33 
  If a name is not a valid alias, the first alias (or the empty string
- 
 
 34 
  if there is none) is used instead.
- 
 
 35 
}
32 
%% Currently no \example: at run time we do not have direct access to Rd
 36 
%% Currently no \example: at run time we do not have direct access to Rd
33 
%% files.  What we could do is take an installed Rd archive, and extract
 37 
%% files.  What we could do is take an installed Rd archive, and extract
34 
%% by splitting on the new-style \eof file separator, but we really want
 38 
%% by splitting on the new-style \eof file separator, but we really want
35 
%% a simple example, right?
 39 
%% a simple example, right?
36 
\keyword{documentation}
 40 
\keyword{documentation}
37 
\keyword{utilities}
 41 
\keyword{utilities}
38 
 
 -