[R-pkg-devel] R CMD check "no-nanny" option?

Kevin Coombes kevin.r.coombes at gmail.com
Thu Jun 11 15:15:10 CEST 2015


When I run "R CMD check --as-cran" on my packages in R 3.2.0, I now get 
a new series of NOTE's telling me that (1) the Description field in the 
DESCRIPTION should file should not start with "This package" or with the 
package name, and (2) the Title field in the DESCRIPTION file should be 
in title case.

Question: Is there any way to turn these notes off and still get the 
rest of cran-style checking?

Grumpy Observation: In reaction to (1), I went to CRAN and randomly 
clicked on a dozen packages to see how many of them follow this rule.  
Half of them violate it explicitly, mostly just starting with "This 
package...".  Most of the rest get around it by starting with a sentence 
fragment that omits the subject (which is _implicitly_ "this package").  
Only one of them started with a complete sentence that gave the 
background of the problem the package was intended to solve.

I strongly believe that it's better to write complete sentences than 
sentence fragments in the Description field. And since the empirical 
evidence suggest that almost everyone at least implicitly starts their 
description with "This package", I'm not sure why the NOTE ever got 
added in the first place....


This email has been checked for viruses by Avast antivirus software.

More information about the R-package-devel mailing list