Package overview document?

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.

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.

Note, things have changed since 2000 and functions.html is no longer built
(as from the next release).  So name clashes are less unimportant, and the
only place these names matter are in your own package unless you want

?00General.Description.dse1

to work.  (I really don't like the long name: what's wrong with
00Description or even 00Intro, the latter being the Unix man-pages
convention?)

Brian

Note, things have changed since 2000 and functions.html is no longer built
(as from the next release).  So name clashes are less unimportant, and the
only place these names matter are in your own package unless you want

?00General.Description.dse1

to work.  (I really don't like the long name: what's wrong with
00Description or even 00Intro, the latter being the Unix man-pages
convention?)

00Intro would be fine with me, but should that have the package name appended or not?

If not, what will happen to name clashes within a bundle?

When you say functions.html will not be built, does that mean there won't be an
overall index? That is the feature of the help system that I use the most.