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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/optparse.R
\docType{class}
\name{OptionParser-class}
\alias{OptionParser-class}
\title{Option Parser}
\description{
Option Parser
}
\section{Slots}{
\describe{
\item{\code{usage}}{The program usage message that will printed out if
\code{parse_args} finds a help option, \code{\%prog} is substituted with the
value of the \code{prog} argument.}
\item{\code{options}}{A list of of \code{OptionParserOption} instances that will
define how \code{parse_args} reacts to command line options.
\code{OptionParserOption} instances are usually created by \code{make_option}
and can also be added to an existing \code{OptionParser} instance via the
\code{add_option} function.}
\item{\code{description}}{Additional text for \code{print_help} to print out between
usage statement and options statement}
\item{\code{epilogue}}{Additional text for \code{print_help} to print out after
the options statement}
\item{\code{formatter}}{A function that \code{print_help} will use to print out after
the options statement. Default is \code{\link[=IndentedHelpFormatter]{IndentedHelpFormatter()}}. This
package also provides the builtin formatter \code{\link[=TitledHelpFormatter]{TitledHelpFormatter()}}.}
}}
\seealso{
\code{\link{OptionParserOption}}
}
\author{
Trevor Davis.
}
|
