docgen: Automatically generate package documentation from a gentest()...

Description Usage Arguments

View source: R/docgen.R

Description

Generates automatically the documentation for a function tested with gentest. Takes into consideration only those results which did not return errors during tests. of the current working directory

Usage

1
docgen(gentest_result, title = attr(gentest_result, "function"))

Arguments

title

String, the title of the . Default: a function name stored in gentest_result.

The documentation file is saved as XXX.Rd – where XXX is determined by the function name stored in the gentest_result – in the sub-directory man of the current working directory. This sub-directory needs to be created first, if it does not yet exist.

gentest_restult

Value returned by gentest.


alekrutkowski/gentest documentation built on May 10, 2017, 11:12 p.m.