From dmurdoch@pair.com  Sun Dec 31 11:53:23 2000
From: dmurdoch@pair.com (Duncan Murdoch)
Date: Sun, 31 Dec 2000 11:53:23 GMT
Subject: [Rd] Package overview document?
Message-ID: <3a511b4d.58240644@smtp1.sympatico.ca>

I'm not sure if this is a devel or help question.

I'd like to write an overview of a package, and have it show up when
someone types

 library(help=mypackage)

or

 help(package=mypackage)

or even better, 

 ?mypackage

Right now, the first two give me a copy of the INDEX file; what I'd
like to see is a longer description.  Is it reasonable to write such a
description into the INDEX file?  Is there some other file where I can
put it, so that it will show up when someone asks about my package?

What about the latter version?  Wouldn't it be a nice improvement if
that were possible, too?

Duncan Murdoch
-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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?
Duncan Murdoch