optparse_flag

To be used with <code>optparse_parameters</code>. This function tells
the provided parameter is a trigger (logical - TRUE/FALSE).
When the trigger parameter is not provided in the command line,
the value is FALSE. Otherwise, it is TRUE.

Provides a set of utility function to prevent the spread of
utilities script in W4M (Workflow4Metabolomics) scripts, and centralize
them in a single package.
Some are meant to be replaced by real packages in a near future, like
the parse_args() function: it is here only to prepare the ground for
more global changes in W4M scripts and tools.

Lain Pavot

W4MRUtils

Utils List for W4M - Workflow for Metabolomics

Melanie Petera

optparse_flag function

<dl><dt>help</dt>
<dd><ul>
<li>The help string to display when --help is triggered</li>
</ul></dd>
<dt>short</dt>
<dd><ul>
<li>The shortcut fir this parameter. For example
for a --output param, we could use
<code>optparse_flag(short = "-o", ...)</code> to set the "-o" shortcut.</li>
</ul></dd>
<dt>default</dt>
<dd><ul>
<li>The default value this parameter will hold.</li>
</ul></dd></dl>

Arguments

Author

optparse_flag - define a command parameter as a trigger — optparse_flag

<dl>

<dt>help</dt>
<dd><ul>
<li>The help string to display when --help is triggered</li>
</ul></dd>


<dt>short</dt>
<dd><ul>
<li>The shortcut fir this parameter. For example
for a --output param, we could use
<code>optparse_flag(short = "-o", ...)</code> to set the "-o" shortcut.</li>
</ul></dd>


<dt>default</dt>
<dd><ul>
<li>The default value this parameter will hold.</li>
</ul></dd>

</dl>

optparse_flag: optparse_flag - define a command parameter as a trigger

Description

Usage

Value

Arguments

Author

See Also

Examples