Learn R Programming

⚠️There's a newer version (1.1.19) of this package.Take me there.

wyz.code.rdoc (version 1.1.7)

Wizardry Code Offensive Programming R Documentation

Description

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.

Copy Link

Version

Install

install.packages('wyz.code.rdoc')

Monthly Downloads

245

Version

1.1.7

License

GPL-3

Maintainer

Fabien Gelineau

Last Published

October 8th, 2019

Functions in wyz.code.rdoc (1.1.7)

WrapperObject

Wrapper object.
generateReference

Generate R documentation reference piece
generateS3MethodSignature

Generate S3 method signature
generateSection

Generate a R documentation section
sentensize

Sentensize a string
generateSpecialLink

Generate R documentation special link
generateDocumentationContent

Generate R documentation file.
generateDocumentationFile

Generate R documentation file
rdocKeywords

R documentation keywords
retrievePackageFunctionNames

Retrieve Package Function Names
generateWrapperObject

Generate wrapper object.
getObjectSignature

Get Object Signature
generateContent

Generate R documentation content