From Kurt.Hornik@ci.tuwien.ac.at  Wed May  9 20:41:56 2001
From: Kurt.Hornik@ci.tuwien.ac.at (Kurt Hornik)
Date: Wed, 9 May 2001 21:41:56 +0200
Subject: [Rd] Package overview document?
In-Reply-To: <3AF97DAA.BBFC6FC7@bank-banque-canada.ca>
References: <Pine.WNT.4.05.10012311402430.265-100000@tern.stats>
 <3a4f5971.54339465@smtp1.sympatico.ca>
 <3AF97DAA.BBFC6FC7@bank-banque-canada.ca>
Message-ID: <15097.40324.870687.597994@mithrandir.hornik.net>

>>>>> Paul Gilbert writes:

> This came from deep in my unresolved pile:
>>> On Sun, 31 Dec 2000, Duncan Murdoch wrote:
>>>> I'd like to write an overview of a package, and have it show up when

>>>> someone types
>>>> 
>>>> library(help=mypackage)
>   ...
>>> The problem is ensuring that you have a non-clashing name. dse1 has
>>> 00General.Description which seems to me to be very likely to clash.
> ...
>> I think the most obvious choice of name is the name of the package,
>> but that would clash fairly often with the name of a function within
>> it (e.g. boot), and it wouldn't show up first in alphabetical lists.

> Is there yet any prescribed approach. If not, I would like to suggest
> 00General.Description.xxx where xxx is replaced by the package name.
> The 00 is to put it near the beginning of the index, but there may be
> a better way.

Currently, library(help = PKG) shows the contents of the files TITLE,
DESCRIPTION and INDEX in that order.  For the time being, I would
recommend adding to INDEX, or maybe have something in INDEX pointing to
another file (e.g. contained in inst/doc so that it will be installed to
the doc subdir of the package).

More long term, we will have a better demo mechanism and better markup
for documentation ...

Best,
-k
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._


[Rd] Package overview document?
Kurt Hornik