writeUnitVignette

Writes a vignette that contains the results from running unit test suites.

Provides some low-level utilities to use for package
development. It currently provides managers for multiple package specific
options and registries, vignette, unit test and bibtex related utilities.
It serves as a base package for packages like 'NMF', 'RcppOctave', 'doRNG', and
as an incubator package for other general purposes utilities, that will
eventually be packaged separately.
It is still under heavy development and changes in the interface(s) are
more than likely to happen.

Renaud Gaujoux

pkgmaker

Development Utilities for R Packages

writeUnitVignette function

<dl><dt>pkg</dt>
<dd>Package name</dd>
<dt>file</dt>
<dd>Output Sweave (.Rnw) file</dd>
<dt>results</dt>
<dd>result file or output character vector</dd>
<dt>check</dt>
<dd>logical that indactes the cal was made from R CMD check,
in which case the vignette is updated only if results of unit tests can
be found in the unit test output directory, where they would have been
generated by <code>utest</code>.</dd></dl>

Arguments

Writes Unit Tests Vignette — writeUnitVignette

<dl>

<dt>pkg</dt>
<dd>Package name</dd>


<dt>file</dt>
<dd>Output Sweave (.Rnw) file</dd>


<dt>results</dt>
<dd>result file or output character vector</dd>


<dt>check</dt>
<dd>logical that indactes the cal was made from R CMD check,
in which case the vignette is updated only if results of unit tests can
be found in the unit test output directory, where they would have been
generated by <code>utest</code>.</dd>

</dl>

writeUnitVignette: Writes Unit Tests Vignette

Description

Usage

Value

Arguments