[Rd] R CMD check

Paul Gilbert pgilbert@bank-banque-canada.ca
Thu, 29 Nov 2001 12:09:18 -0500


Martyn Plummer wrote:

> I'm being encouraged to document it as
> 
> \usage{
> summary.mcmc(data, quantiles = c(0.025, 0.25, 0.5, 0.75, 0.975), ...)
> }
> 

I think you are being encouraged to document it as

 \usage{
 \method{summary}{mcmc}(data, quantiles = c(0.025, 0.25, 0.5, 0.75, 0.975), ...)
 }

So it displays properly in the documentation and also gets checked properly. You
will then stop getting the "usage ...but missing from code" error and start
getting the "generic/method mismatch error." These guys are real slave drivers,
but as you said 

>this has uncovered a large number of errors and inconsistencies in my >documentation, for which I am very grateful.

Me too.

Paul Gilbert
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-devel-request@stat.math.ethz.ch
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._