Allows to generate automatically R documentation files from offensive programming test cases. It populates most of the section of the documentation content from the offensive programming instrumentation. This reduces greatly the package producer effort and time to get to a fully documented manual page for any instrumented function. Following documentation sections are now automatically filled from instrumentation data: title, description, usage, arguments, value, author, examples. Sections references, notes and keyword are instrumented to industrialize their production. Produced manual pages are ready for completion (e.g note section if needed), language and phrasal adjustments. Main task for the package producer is now review, no more content production. Refer to chapter 11 of Offensive Programming Book, Fabien GELINEAU (2019, ISBN:979-10-699-4075-8), to learn about details and get value from this package.
| Version: | 1.1.15 |
| Depends: | R (≥ 3.6) |
| Imports: | methods, data.table (≥ 1.11.8), tidyr, lubridate (≥ 1.7.4), wyz.code.offensiveProgramming (≥ 1.1.17), stringr (≥ 1.4.0), R6 (≥ 2.4.0), crayon (≥ 1.3.4), digest (≥ 0.6.23) |
| Suggests: | testthat, knitr, rmarkdown |
| Published: | 2020-02-13 |
| Author: | Fabien Gelineau |
| Maintainer: | Fabien Gelineau <neonira at gmail.com> |
| License: | GPL-3 |
| NeedsCompilation: | no |
| CRAN checks: | wyz.code.rdoc results |
| Reference manual: | wyz.code.rdoc.pdf |
| Vignettes: |
wyz.code.rdoc documentation wyz.code.rdoc releases wyz.code.rdoc Tips and Tricks wyz.code.rdoc Tutorial wyz.code.rdoc use cases |
| Package source: | wyz.code.rdoc_1.1.15.tar.gz |
| Windows binaries: | r-devel: wyz.code.rdoc_1.1.15.zip, r-devel-gcc8: wyz.code.rdoc_1.1.15.zip, r-release: wyz.code.rdoc_1.1.15.zip, r-oldrel: wyz.code.rdoc_1.1.7.zip |
| OS X binaries: | r-release: wyz.code.rdoc_1.1.15.tgz, r-oldrel: wyz.code.rdoc_1.1.7.tgz |
| Old sources: | wyz.code.rdoc archive |
Please use the canonical form https://CRAN.R-project.org/package=wyz.code.rdoc to link to this page.