OptionParser-class

A command line parser inspired by Python's 'optparse' library to
be used with Rscript to write "#!" shebang scripts that accept short and
long flag/options.

Trevor L Davis

optparse

Command Line Option Parser

Trevor L. Davis

Allen Day

Python Software Foundation 

Steve Lianoglou

Jim Nikelski

Kirill Müller

Peter Humburg

Rich FitzJohn

Gyu Jin Choi

OptionParser-class function

<dl>
<dt><code>usage</code></dt>
<dd>The program usage message that will printed out if
<code>parse_args</code> finds a help option, <code>%prog</code> is substituted with the
value of the <code>prog</code> argument.</dd></dl>
<dt><code>options</code></dt>
<dd>A list of of <code>OptionParserOption</code> instances that will
define how <code>parse_args</code> reacts to command line options.
<code>OptionParserOption</code> instances are usually created by <code>make_option</code>
and can also be added to an existing <code>OptionParser</code> instance via the
<code>add_option</code> function.</dd>
<dt><code>description</code></dt>
<dd>Additional text for <code>print_help</code> to print out between
usage statement and options statement</dd>
<dt><code>epilogue</code></dt>
<dd>Additional text for <code>print_help</code> to print out after
the options statement</dd>
<dt><code>formatter</code></dt>
<dd>A function that <code>print_help</code> will use to print out after
the options statement. Default is <code>IndentedHelpFormatter()</code>. This
package also provides the builtin formatter <code>TitledHelpFormatter()</code>.</dd>

Slots

Author

Option Parser — OptionParser-class

<dl>
<dt><code>usage</code></dt>
<dd>The program usage message that will printed out if
<code>parse_args</code> finds a help option, <code>%prog</code> is substituted with the
value of the <code>prog</code> argument.</dd>


<dt><code>options</code></dt>
<dd>A list of of <code>OptionParserOption</code> instances that will
define how <code>parse_args</code> reacts to command line options.
<code>OptionParserOption</code> instances are usually created by <code>make_option</code>
and can also be added to an existing <code>OptionParser</code> instance via the
<code>add_option</code> function.</dd>


<dt><code>description</code></dt>
<dd>Additional text for <code>print_help</code> to print out between
usage statement and options statement</dd>


<dt><code>epilogue</code></dt>
<dd>Additional text for <code>print_help</code> to print out after
the options statement</dd>


<dt><code>formatter</code></dt>
<dd>A function that <code>print_help</code> will use to print out after
the options statement. Default is <code>IndentedHelpFormatter()</code>. This
package also provides the builtin formatter <code>TitledHelpFormatter()</code>.</dd>


</dl>

Option Parser

OptionParser-class: Option Parser

Description

Arguments

Slots

Author

See Also