Skip to content

Commit afc6d86

Browse files
committed
Remove 'default' argument from reg_positionals_list()
1 parent 5af8948 commit afc6d86

File tree

6 files changed

+24
-24
lines changed

6 files changed

+24
-24
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Package: cmdparseR
22
Title: Command Line Parser
3-
Version: 0.1.2
3+
Version: 0.1.3
44
Authors@R:
55
person(given = "Jeffrey",
66
family = "Perkel",

R/parse_command_line.R

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -307,25 +307,25 @@ reg_argument_list <- function(plist) {
307307

308308
#
309309
# Register a 'positional' command line argument (ie, the last argument in the list)
310-
reg_positionals <- function(var, default, help) {
311-
reg_argument (lparam = NA, sparam = NA, var = var, default = default, argType = argsType$TypePositional, help = help)
310+
reg_positionals <- function(var, help) {
311+
reg_argument (lparam = NA, sparam = NA, var = var, default = NA, argType = argsType$TypePositional, help = help)
312312
} # reg_positionals
313313

314314

315315
#' Register a list of 'positional' arguments
316316
#'
317-
#' @param plist list of positional arguments: variable name, default value, help text
317+
#' @param plist list of positional arguments: variable name, help text
318318
#'
319319
#' @export
320320
#'
321321
#' @examples
322-
#' args <- list(c("infile",NA,"input file"))
322+
#' args <- list(c("infile","input file"))
323323
reg_positionals_list <- function(plist) {
324-
ids <- c("var","default","help")
324+
ids <- c("var","help")
325325

326326
for (p in plist) {
327327
stopifnot(length(p) == length(ids))
328-
reg_positionals(var = p[1], default = p[2], help = p[3])
328+
reg_positionals(var = p[1], help = p[2])
329329
}
330330
} # reg_positionals_list
331331

@@ -334,7 +334,7 @@ reg_positionals_list <- function(plist) {
334334
#'
335335
#' @param d the date to parse (string)
336336
#'
337-
#' @return A tuple: c(y, m, d)
337+
#' @return A vector: c(y, m, d)
338338
#' @export
339339
#'
340340
#' @examples

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ main <- function() {
7373
reg_argument_list(args)
7474

7575
pos <- list(
76-
# variable name, default, help string
77-
c('outfile',NA,'Output filename'),
78-
c('infiles',NA,'Input filename(s)')
76+
# variable name, help string
77+
c('outfile','Output filename'),
78+
c('infiles','Input filename(s)')
7979
)
8080
reg_positionals_list(pos)
8181

@@ -91,18 +91,18 @@ main()
9191
Invoked like so:
9292

9393
```
94-
Rscript test_cmdparser.R add file -c ~/tmp/config.txt -d -vvv -k key1 -k key2 -z -r 2020:2022 outfile.txt infile1.txt infile2.txt infile3.txt
94+
Rscript test_cmdparseR.R add name -dvvv -r 2020:2022 -z -k key1 -k key2 outfile.txt infile1.txt infile2.txt infile3.txt
9595
```
9696

9797
you should see the following:
9898
```
99-
$ Rscript test_cmdparser.R add file -c ~/tmp/config.txt -d -vvv -k key1 -k key2 -z -r 2020:2022 outfile.txt infile1.txt infile2.txt infile3.txt
99+
$ Rscript test_cmdparseR.R add name -dvvv -r 2020:2022 -z -k key1 -k key2 outfile.txt infile1.txt infile2.txt infile3.txt
100100
Warning: parse_command_line(): unknown param: -z
101101
$help
102102
[1] "FALSE"
103103
104104
$config
105-
[1] "~/Users/username/tmp/config.txt"
105+
[1] "~/myconfigfile.txt"
106106
107107
$debug
108108
[1] TRUE
@@ -126,17 +126,17 @@ $command
126126
[1] "add"
127127
128128
$subcmd
129-
[1] "file"
130-
131-
$unknowns
132-
[1] "-z"
129+
[1] "name"
133130
134131
$daterange1
135132
[1] "2020"
136133
137134
$daterange2
138135
[1] "2022"
139136
137+
$unknowns
138+
[1] "-z"
139+
140140
```
141141

142142
`cmdparseR` provides a `usage()` function to create a formatted help message based on the `desc` strings passed to `reg_argument_list()`, `reg_command_list()` and `reg_subcmd_list()`. By default, `--help` or `-?` on the command line will call this function:

man/parse_date.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/reg_positionals_list.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

test_cmdparseR.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ main <- function() {
88
c('delete', 'Delete something')
99
)
1010
reg_command_list(cmds)
11-
11+
1212
subcmds <- list(
1313
c('name','add','Add a name'),
1414
c('file','add','Add a file'),
@@ -27,8 +27,8 @@ main <- function() {
2727
reg_argument_list(args)
2828

2929
pos <- list(
30-
c('outfile',NA,'Output filename'),
31-
c('infiles',NA,'Input filename(s)')
30+
c('outfile','Output filename'),
31+
c('infiles','Input filename(s)')
3232
)
3333
reg_positionals_list(pos)
3434

0 commit comments

Comments
 (0)