Package: wyz.code.rdoc 1.1.19

wyz.code.rdoc: Wizardry Code Offensive Programming R Documentation

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.

Authors:Fabien Gelineau <[email protected]>

wyz.code.rdoc_1.1.19.tar.gz
wyz.code.rdoc_1.1.19.zip(r-4.5)wyz.code.rdoc_1.1.19.zip(r-4.4)wyz.code.rdoc_1.1.19.zip(r-4.3)
wyz.code.rdoc_1.1.19.tgz(r-4.4-any)wyz.code.rdoc_1.1.19.tgz(r-4.3-any)
wyz.code.rdoc_1.1.19.tar.gz(r-4.5-noble)wyz.code.rdoc_1.1.19.tar.gz(r-4.4-noble)
wyz.code.rdoc_1.1.19.tgz(r-4.4-emscripten)wyz.code.rdoc_1.1.19.tgz(r-4.3-emscripten)
wyz.code.rdoc.pdf |wyz.code.rdoc.html
wyz.code.rdoc/json (API)

# Install 'wyz.code.rdoc' in R:
install.packages('wyz.code.rdoc', repos = c('https://neonira.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/neonira/offensiveprogrammingbook_v1.2.2/issues

Datasets:

On CRAN:

2.70 score 1 scripts 236 downloads 34 exports 25 dependencies

Last updated 3 years agofrom:983f4cc651. Checks:OK: 3 NOTE: 4. Indexed: yes.

TargetResultDate
Doc / VignettesOKOct 17 2024
R-4.5-winNOTEOct 17 2024
R-4.5-linuxNOTEOct 17 2024
R-4.4-winNOTEOct 17 2024
R-4.4-macNOTEOct 17 2024
R-4.3-winOKOct 17 2024
R-4.3-macOKOct 17 2024

Exports:auditDocumentationFilesbeautifycompleteManualPagecomputeDocumentationStatisticsconvertExamplesescapeContentgenerateEncgenerateEnumerationgenerateMarkupgenerateOptionLinkgenerateOptionSexprgenerateParagraphgenerateParagraph2NLgenerateParagraphCRgenerateReferencegenerateS3MethodSignaturegenerateSectiongenerateTableGenerationContextgetStandardSectionNamesidentifyReplacementVariablesInputContextinterpretResultsManualPageBuilderopRdocInformationProcessingContextproduceAllManualPagesFromObjectproduceDocumentationFileproduceManualPageproducePackageLinkrdocKeywordssentensizeshortcutsverifyDocumentationFile

Dependencies:clicpp11crayondata.tabledigestdplyrfansigenericsgluelifecyclemagrittrpillarpkgconfigpurrrR6rlangstringistringrtibbletidyrtidyselectutf8vctrswithrwyz.code.offensiveProgramming

Release notes of package wyz.code.rdoc

Rendered fromrelease-notes.Rmdusingknitr::rmarkdownon Oct 17 2024.

Last update: 2021-10-06
Started: 2020-04-22

wyz.code.rdoc documentation

Rendered fromdocumentation.Rmdusingknitr::rmarkdownon Oct 17 2024.

Last update: 2020-04-22
Started: 2020-02-13

wyz.code.rdoc Tips and Tricks

Rendered fromtips-and-tricks.Rmdusingknitr::rmarkdownon Oct 17 2024.

Last update: 2021-10-06
Started: 2020-02-13

wyz.code.rdoc Tutorial

Rendered fromtutorial.Rmdusingknitr::rmarkdownon Oct 17 2024.

Last update: 2021-10-06
Started: 2020-02-13

wyz.code.rdoc use cases

Rendered fromuse-cases.Rmdusingknitr::rmarkdownon Oct 17 2024.

Last update: 2021-10-06
Started: 2020-02-13

Readme and manuals

Help Manual

Help pageTopics
Audit Documentation FilesauditDocumentationFiles
Beautify R documentation contentbeautify
Complete Manual PagecompleteManualPage
Compute Documentation StatisticscomputeDocumentationStatistics
Convert ExamplesconvertExamples
Data set dummydummy
Escape Specials Characters In ContentescapeContent
Data set familyfamily
Generate EncgenerateEnc
Generate EnumerationgenerateEnumeration
Generate R documentation atomic piecegenerateMarkup
Generate Option LinkgenerateOptionLink
Generate Option SexprgenerateOptionSexpr
Generate ParagraphgenerateParagraph
Function generateParagraph2NLgenerateParagraph2NL
Function generateParagraphCRgenerateParagraphCR
Generate ReferencegenerateReference
Generate S3 method signaturegenerateS3MethodSignature
Generate SectiongenerateSection
Generate TablegenerateTable
Generation ContextGenerationContext GenerationContext-class
Get Standard Section NamesgetStandardSectionNames
Identify Replacement VariablesidentifyReplacementVariables
Input ContextInputContext InputContext-class
Interpret ResultsinterpretResults
Manual Page BuilderManualPageBuilder ManualPageBuilder-class
Offensive Programming R Documentation InformationopRdocInformation
Processing ContextProcessingContext ProcessingContext-class
Produce All Manual Pages From ObjectproduceAllManualPagesFromObject
Produce Documentation FileproduceDocumentationFile
Produce Manual PageproduceManualPage
Produce Package LinkproducePackageLink
R Documentation KeywordsrdocKeywords
Create sentencesentensize
Function shortcutsshortcuts
Verify Documentation FileverifyDocumentationFile