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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/argparser.R
\name{arg_parser}
\alias{arg_parser}
\title{Create an argument parser.}
\usage{
arg_parser(description, name = NULL, hide.opts = FALSE)
}
\arguments{
\item{description}{description of the program}
\item{name}{name of the program}
\item{hide.opts}{hide the \code{--opts} argument}
}
\value{
a new \code{arg.parser} object
}
\description{
This function creates an \code{arg.parser} object. It infers the program
name from the file name of the invoked script.
}
\details{
The argument parser will be created by default with two arguments:
\code{--help} and \code{--opts}. The latter argument can be used for
loading a list of argument values that are saved in a RDS file.
}
\examples{
p <- arg_parser("A test program")
}
|