computeDocumentationStatistics: Compute Documentation Statistics

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

Description

Compute documentation statistics, providing section length in lines and identifying too long lines.

Usage

computeDocumentationStatistics(filename_s_1, maxLineLength_pi_1 = 100L)

Arguments

filename_s_1	A single string value
maxLineLength_pi_1	A single positive integer value

Details

Wherever a line_length_issue is not NA, you should correct the faulty line by editing the file. Not doing so will very probably imply a failure during check package procedure execution.

Value

A data.table with three columns.

keywords	the section names embedded in the file
lines	the number of lines for the section
line_length_issue	the line numbers where issues are found or NA.

Note

This function should be use when prior package delivery, to ensure documentation lines meet the R documentation specifications.

Author(s)

Fabien Gelineau <[e-mail]>

Maintainer: Fabien Gelineau <[e-mail]>

Examples

# computeDocumentationStatistics('myfile.Rd')

wyz.code.rdoc documentation built on Oct. 6, 2021, 9:07 a.m.