GetoptLong.options: Global options for GetoptLong()

Description Usage Arguments Details Author(s) Examples

View source: R/0_global.R

Description

Global options for GetoptLong()

Usage

1
GetoptLong.options(..., RESET = FALSE, READ.ONLY = NULL, LOCAL = FALSE, ADD = FALSE)

Arguments

...

options, see 'details' section

RESET

Whether to reset options to their default values

READ.ONLY

only return read-only options?

LOCAL

switch local mode

ADD

add new options

Details

Supported options are following:

startingMsg

message that will be printed before the helping message when running Rscript foo.R --help. Ignored if head is set in GetoptLong

endingMsg

message that will be printed after the helping message when running Rscript foo.R --help. Ignored if foot is set in GetoptLong

config

configuration of Getopt::Long, check http://perldoc.perl.org/Getopt/Long.html#Configuring-Getopt%3a%3aLong

GetoptLong.options(...) should be put before calling GetoptLong function.

Author(s)

Zuguang Gu <[email protected]>

Examples

1
2
# There is no example
NULL

jokergoo/GetoptLong documentation built on June 9, 2018, 6:24 p.m.