[Rd] R CMD check may not detect a code/documentation mismatch
Petr Savicky
savicky at cs.cas.cz
Sun Dec 13 11:44:02 CET 2009
For the package at
http://www.cs.cas.cz/~savicky/R-devel/something_0.0.0.tar.gz
which is a minor part of some other package only to demonstrate the
problem, i get (under R version 2.11.0 Under development 2009-12-12 r50714
and also under R-2.9.2, openSUSE 11.1 (x86_64) and CentOS release 5.2)
R CMD check something_0.0.0.tar.gz
...
* checking Rd files ... OK
* checking Rd metadata ... OK
* checking Rd cross-references ... OK
* checking for missing documentation entries ... OK
* checking for code/documentation mismatches ... OK
* checking Rd \usage sections ... OK
* checking examples ... NONE
* checking PDF version of manual ... OK
although the package code contains
testCoreNA <- function()
and the documentation contains
\usage{
testCoreClass(verbose=0)
testCoreAttrEval(verbose=0)
testCoreReg(verbose=0)
testCoreNA(verbose=0)
}
There is a mismatch between code and documentation of testCoreNA(). Is the
problem caused by having four entries in \usage{} section?
Petr Savicky.
More information about the R-devel
mailing list