docopt

docopt helps you to:

• define an interface for your command-line app, and
• automatically generate a parser for it.

For more information see docopt.org

R package docopt is an implementation of docopt in the R language.

Install

The latest version of docopt can be installed using:

library(devtools)  # make sure to have devtools 1.4!
install_github("edwindj/docopt.R")

It is tested against the tests defined for the reference implementation. It passes most tests. It currently fails tests that

• count arguments: my_prog.R -v -v should return list(v=2)
• multiple prog statement: i.e. my_prog.R -a \n prog -b

The tests can be run using devtools test() and can be found in "inst/tests"

Usage

docopt uses the description of the command-line interface to parse command line arguments.

'usage: my_prog.R [-a -r -m <msg>]

options:
 -a        Add
 -r        Remote
 -m <msg>  Message' -> doc

# load the docopt library
library(docopt)
# retrieve the command-line arguments
opts <- docopt(doc)
# what are the options?
str(opts)

## List of 3
##  $ -a: logi FALSE
##  $ -r: logi FALSE
##  $ -m: chr "<msg>"

# or set them manually
opts <- docopt(doc, "-m Hello")
str(opts)

## List of 3
##  $ -a: logi FALSE
##  $ -r: logi FALSE
##  $ -m: chr "Hello"