[Rd] R CMD build

[Prof Brian D Ripley]

On Wed, 29 Mar 2000, Paul Gilbert wrote:

> I've been trying "R CMD build" to build my packages because of the
> various nice checks it does. Here are some questions/comments/problems.
> 
> 1/ I get a WARNING about RD files without alias for (what seems like)
> all my Rd files. I'm not sure if this is related to the fact that all my
> functions are in one .R file.

Well, are there \alias entries in the Rd files?  (The layout of the .R file
is immaterial: in the installed code all R functions are always in one
file.) `build' expects a \alias as well as a \name.

If the \alias are there, we may be hitting again problems with the 
different dialects of egrep and sed.  AFAIK the current version
behaves itself on Solaris 2.6/7 and on POSIX platforms.

> 2/ I get a warning about undocumented objects for all the specific
> methods of generic functions. In many cases only the generic is
> documented, so the warning is correct, but there are so many of them
> that it tends to obscure more important warnings.

The convention is to put a \alias for the method in the help file for the
generic.  R-core are divided on this point!  At least now the indices
(e.g. in HTML help and the LaTeX manual) will try to omit the methods.

> 3/ It doesn't work with bundles.

True, but it will check every package in a bundle.  The only bundle
I know of is VR, and that is built by a highly specific script.  If
(as your comment suggests) there is a need to build other bundles, we
can look into extending `build'.

> 4/ Checking for undocumented objects fails with an ERROR when checking
> an (undocumented) assignment object ( "input.series.names<-" ).

I think it works if you document it, though, and the error is correct,
surely?  Do you mean it gives ERROR and then stops rather than warns?

-- 
Brian D. Ripley,                  ripley@stats.ox.ac.uk
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford,             Tel:  +44 1865 272861 (self)
1 South Parks Road,                     +44 1865 272860 (secr)
Oxford OX1 3TG, UK                Fax:  +44 1865 272595

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._