Learn R Programming

wyz.code.rdoc (version 1.1.19)

computeDocumentationStatistics: Compute Documentation Statistics

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

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.

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.

Examples

Run this code
# NOT RUN {
# computeDocumentationStatistics('myfile.Rd')
# }

Run the code above in your browser using DataLab