auditDocumentationFiles: Audit Documentation Files
In neonira/wyz.code.rdoc: Wizardry Code Offensive Programming R Documentation
Description
Usage
Arguments
Value
Classification
Author(s)
See Also
Examples
View source: R/auditDocumentationFiles.R
Description
Audit documentation files from a set of folders
Usage
1
auditDocumentationFiles(folder_s_1m)
Arguments
folder_s_1m
An length-1 or more vector of existing folder names
Value
Provides a named list with two entries named correct and
incorrect. All entries are file names.
Incorrect entries are the ones that
has length issues as detected by function computeDocumentationStatistics
Classification
STRATUM symbol ▶ LAYER_1
PHASING ▶ BUILD
INTENT ▶ QUALITY_CONTROL
Author(s)
Fabien Gelineau <neonira@gmail.com>
Maintainer: Fabien Gelineau <neonira@gmail.com>
See Also
Function verifyDocumentationFile allows to check documentation content
using standard R function tools:checkRd.
Examples
1
auditDocumentationFiles('man')
neonira/wyz.code.rdoc documentation built on Feb. 19, 2020, 12:47 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Description Usage Arguments Value Classification Author(s) See Also Examples
View source: R/auditDocumentationFiles.R
Description
Audit documentation files from a set of folders
Usage
1 | auditDocumentationFiles(folder_s_1m)
|
Arguments
folder_s_1m |
An length-1 or more vector of existing folder names |
Value
Provides a named list with two entries named correct and
incorrect. All entries are file names.
Incorrect entries are the ones that
has length issues as detected by function computeDocumentationStatistics
Classification
STRATUM symbol ▶ LAYER_1
PHASING ▶ BUILD
INTENT ▶ QUALITY_CONTROL
Author(s)
Fabien Gelineau <neonira@gmail.com>
Maintainer: Fabien Gelineau <neonira@gmail.com>
See Also
Function verifyDocumentationFile allows to check documentation content
using standard R function tools:checkRd.
Examples
1 | auditDocumentationFiles('man')
|
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.