wyz.code.rdoc (version 1.1.19)

auditDocumentationFiles: Audit Documentation Files

Description

Audit documentation files from a set of folders

Usage

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.

See Also

Function verifyDocumentationFile allows to check documentation content using standard R function tools:checkRd.

Examples

# NOT RUN {
auditDocumentationFiles('man')
# }