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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/deprecated.R
\name{add.argument}
\alias{add.argument}
\title{Add an argument to a parser.}
\usage{
add.argument(
parser,
arg,
help,
default = NULL,
type = NULL,
flag = NULL,
short = NULL
)
}
\arguments{
\item{parser}{an \code{arg.parser} object}
\item{arg}{argument name (use no prefix for positional arguments,
\code{--} or \code{-} prefix for optional arguments or flags)}
\item{help}{help description for the argument}
\item{default}{default value for the argument [default: NA]}
\item{type}{variable type of the argument (which can be inferred from
\code{default}), assumed to be \code{character} otherwise}
\item{flag}{whether argument is a flag (and does not consume a value)
[default: FALSE]}
\item{short}{short-form for flags and positional arguments;
short-forms can be assigned automatically based on the first
character of the argument name, unless a conflict arises with
an existing short-form; to avoid conflicts, add the argument
as early as possible}
}
\value{
an \code{arg.parser} object with the argument added
}
\description{
This function is deprecated. Use \code{add_argument} instead.
}
|
