Skip to content

check for \value in R CMD check

2 messages · Ivan Krylov, Sebastian Meyer

#
This was discussed a bit in July 2025:
https://stat.ethz.ch/pipermail/r-package-devel/2025q3/011824.html

Part of the problem with an automatic check is that it can be easily
circumvented by adding a one-line value section (as many packages are
wont to do, "#' @return data.frame" with no further context), so human
review will still be needed.

It's probably worth adding such a check, initially with a level below
-1, so that it's not reported by R CMD check by default and doesn't
blow up CRAN.
1 day later
#
Am 14.02.26 um 12:35 schrieb Ivan Krylov via R-devel:
Thanks, I agree. There is no technical requirement for a \value section 
in Rd files but I suppose package reviewers will have a keen sense of 
when one is really missing or incomplete. That said, an indication of 
help pages without a \value section would certainly be useful for 
developers.

With r89420, there now is an experimental environment variable

     _R_CHECK_RD_CONTENTS_VALUE_

for tools::checkRdContents(), a function also used by R CMD check. If 
set to a true value, the check results will show (some of the) Rd files 
without \value.

	Sebastian Meyer