From ggrothendieck at gmail.com  Tue Jun  7 14:29:31 2005
From: ggrothendieck at gmail.com (Gabor Grothendieck)
Date: Tue Jun  7 14:30:10 2005
Subject: [Rd] Suggestion: help(<package name>)
In-Reply-To: <42A57F5D.7080505@maths.lth.se>
References: <42A57F5D.7080505@maths.lth.se>
Message-ID: <971536df05060705292c7b0e21@mail.gmail.com>

On 6/7/05, Henrik Bengtsson <hb@maths.lth.se> wrote:
> Hi,
> 
> I would like to suggest a standard where all packages provide an Rd page
> with the same name (or aliased) as the name of package so that
> help(<package name>) or ?<package name> is always here. This especially
> of interest to large packages with a large package index. This page
> could explain the package in general and gives some hints on how to
> start - not like extensive vignettes, but just to get started, e.g. list
> the "most important" functions.  This page could typically contain
> information that is in the DESCRIPTION file (which contains valuable
> information hardly every accessed by a general user), such as who is the
> maintainer, how to report bugs and so on.
> 
> If you think the above is a good idea, then, would it even be useful to
> enforce the existance of such a Rd page in R CMD check?

The basic idea of having a short overview seems good but
the particular suggestion of using ?packagename would
seem to collide with already existing .Rd files as
many packages are named after their constructor, e.g. the zoo
package.


[Rd] Suggestion: help(<package name>)
Gabor Grothendieck