write.fmt

function for writing ehelp output to a local LaTeX file

internal

By overloading the R help() function, this package allows users to use "docstring" style comments within their own defined functions. The package also provides additional functions to mimic the R basic example() function and the prototyping of packages.

Marcelo Ponce

ehelp

Enhanced Help to Enable "Docstring"-Comments in Users Functions

write.fmt function

<dl><dt>X.obj</dt>
<dd>ehelp object</dd>
<dt>format</dt>
<dd>type of output: txt, latex, html</dd>
<dt>filename</dt>
<dd>name of the file where to write the documentation</dd>
<dt>leaveOpen</dt>
<dd>boolean argument to leave the file open</dd></dl>

Arguments

function for writing ehelp output to a local LaTeX file — write.fmt

<dl>

<dt>X.obj</dt>
<dd>ehelp object</dd>


<dt>format</dt>
<dd>type of output: txt, latex, html</dd>


<dt>filename</dt>
<dd>name of the file where to write the documentation</dd>


<dt>leaveOpen</dt>
<dd>boolean argument to leave the file open</dd>

</dl>

write.fmt: function for writing ehelp output to a local LaTeX file

Description

Usage

Arguments