makeArgument: Make argument object.

Description Usage Arguments Value

Description

Make argument object.

Usage

1
2
makeArgument(name, shortcut = NULL, alias = NULL, is.flag = FALSE,
  default = NULL, type = NULL, required = FALSE, help)

Arguments

name

[character(1)]
Name of the argument.

shortcut

[character(1)]
Shortcut name of the argument. Default is NULL, i. e., no shortcut.

alias

[character]
Character vector of alias names for name argument. Default is NULL, i. e., no aliases at all.

is.flag

[logical(1)]
Set this to TRUE, if the argument is a flag, i. e., it has no value.

default

[any]
Default value for the argument. Keep in mind, that this must be of the corresponding type. If no default value is defined, which is the default, the user has to provide a value.

type

[character(1)]
The type of the argument. Argument values are coerced to the type. Keep in mind, that this argument is neglected if is.flag is set to TRUE.

required

[logical(1)]
Set this to TRUE, if the user must provide this argument. Default ist FALSE.

help

[character(1)]
Helping text.

Value

[RargsArgument] Argument object.


jakobbossek/Rargs documentation built on May 18, 2019, 9:08 a.m.