Learn R Programming

wyz.code.rdoc (version 1.1.19)

Wizardry Code Offensive Programming R Documentation

Description

Allows to generate on-demand or by batch, any R documentation file, whatever is kind, data, function, class or package. It populates documentation sections, either automatically or by considering your input. Input code could be standard R code or offensive programming code. Documentation content completeness depends on the type of code you use. With offensive programming code, expect generated documentation to be fully completed, from a format and content point of view. With some standard R code, you will have to activate post processing to fill-in any section that requires complements. Produced manual page validity is automatically tested against R documentation compliance rules. Documentation language proficiency, wording style, and phrasal adjustments remains your job.

Copy Link

Version

Install

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

Monthly Downloads

224

Version

1.1.19

License

GPL-3

Maintainer

Fabien Gelineau

Last Published

October 6th, 2021

Functions in wyz.code.rdoc (1.1.19)

generateOptionSexpr

Generate Option Sexpr
generateOptionLink

Generate Option Link
generateEnumeration

Generate Enumeration
generateEnc

Generate Enc
generateMarkup

Generate R documentation atomic piece
generateParagraphCR

Function generateParagraphCR
generateParagraph2NL

Function generateParagraph2NL
generateParagraph

Generate Paragraph
escapeContent

Escape Specials Characters In Content
family

Data set family
generateTable

Generate Table
generateReference

Generate Reference
generateS3MethodSignature

Generate S3 method signature
interpretResults

Interpret Results
generateSection

Generate Section
computeDocumentationStatistics

Compute Documentation Statistics
opRdocInformation

Offensive Programming R Documentation Information
produceManualPage

Produce Manual Page
shortcuts

Function shortcuts
producePackageLink

Produce Package Link
verifyDocumentationFile

Verify Documentation File
produceAllManualPagesFromObject

Produce All Manual Pages From Object
produceDocumentationFile

Produce Documentation File
getStandardSectionNames

Get Standard Section Names
rdocKeywords

R Documentation Keywords
identifyReplacementVariables

Identify Replacement Variables
sentensize

Create sentence
convertExamples

Convert Examples
auditDocumentationFiles

Audit Documentation Files
beautify

Beautify R documentation content
completeManualPage

Complete Manual Page
InputContext-class

Input Context
ProcessingContext-class

Processing Context
GenerationContext-class

Generation Context
dummy

Data set dummy
ManualPageBuilder-class

Manual Page Builder