[Rd] R CMD build/check

Martin Maechler Martin Maechler <maechler@stat.math.ethz.ch>
Mon, 10 Apr 2000 10:41:48 +0200 (CEST)

>>>>> "KH" == Kurt Hornik <hornik@ci.tuwien.ac.at> writes:

    KH> I would like to bring the attention of R package maintainers/developers
    KH> to the mechanisms for checking and building add-on packages that come
    KH> with the R distribution.

    KH> * R CMD check has been around for a while.  It can be used for run-time
    KH> testing the examples that come with an installed add-on package.  Recent
    KH> development versions of R also have preliminary support for additional
    KH> specific regression testing.

    KH> * R CMD build should be used for actually building the add-on packages,
    KH> in particular if you are planning to upload them to CRAN.  From the R
    KH> Extension Writers Guide:

    KH> Prior to actually building the package in the common gzipped tar
    KH> file format, a variety of diagnostic checks and cleanups are
    KH> performed.  In particular, it is tested whether the
    KH> `DESCRIPTION' file contains the required entries, whether object
    KH> and data indices exist and can be assumed to be up-to-date,
    KH> whether the documentation sources contain the required name,
    KH> alias, title, description, and keyword information, and whether
    KH> there are any undocumented user level objects.

    KH> Please try to eliminate all problems reported by the R package builder
    KH> before submitting a package to CRAN.

The "data index" is mentioned in the R Extensions Writer guide as
>> The subdirectory should contain a `00Index' file
>> that describes the datasets available.

Now since this is now required,  
what is the format of that file? what must/should it contain?
Shouldn't this be built automatically from the data's *.Rd files when it
doesn't exist?

Thanks for any clarification; the requirement of this 00Index has been new
for me (must have slept at some time in the past...).

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