From pgilbert@bank-banque-canada.ca  Wed May  9 18:26:02 2001
From: pgilbert@bank-banque-canada.ca (Paul Gilbert)
Date: Wed, 09 May 2001 13:26:02 -0400
Subject: [Rd] Package overview document?
References: <Pine.WNT.4.05.10012311402430.265-100000@tern.stats> <3a4f5971.54339465@smtp1.sympatico.ca>
Message-ID: <3AF97DAA.BBFC6FC7@bank-banque-canada.ca>

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.

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


[Rd] Package overview document?
Paul Gilbert