computeDocumentationStatistics: Compute Documentation Statistics

Description Usage Arguments Details Value Classification Note Author(s) Examples

View source: R/computeDocumentationStatistics.R

Description

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

Usage

1
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.

Classification

STRATUM ▶ LAYER_3

PHASING ▶ BUILD

INTENT ▶ STATISTICS

Note

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

Author(s)

Fabien Gelineau <neonira@gmail.com>

Maintainer: Fabien Gelineau <neonira@gmail.com>

Examples

1
# computeDocumentationStatistics('myfile.Rd')

neonira/wyz.code.rdoc documentation built on Feb. 19, 2020, 12:47 p.m.