Description Usage Arguments Details Value Note Author(s) Examples
View source: R/computeDocumentationStatistics.R
Compute documentation statistics, providing section length in lines and identifying too long lines.
1 | computeDocumentationStatistics(filename_s_1, maxLineLength_pi_1 = 100L)
|
filename_s_1 |
A single |
maxLineLength_pi_1 |
A single positive |
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.
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 |
This function should be use when prior package delivery, to ensure documentation lines meet the R documentation specifications.
Fabien Gelineau <neonira@gmail.com>
Maintainer: Fabien Gelineau <neonira@gmail.com>
1 | # computeDocumentationStatistics('myfile.Rd')
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.