From Kurt.Hornik at wu-wien.ac.at  Tue Jun  7 13:10:42 2005
From: Kurt.Hornik at wu-wien.ac.at (Kurt Hornik)
Date: Tue Jun  7 13:10:56 2005
Subject: [Rd] Suggestion: help(<package name>)
In-Reply-To: <42A57F5D.7080505@maths.lth.se>
References: <42A57F5D.7080505@maths.lth.se>
Message-ID: <17061.32946.976628.961120@beren.wu-wien.ac.at>

>>>>> Henrik Bengtsson writes:

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

How would this be different from the results of

	help(package = <package name>)

?

-k

> 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?

> Henrik Bengtsson

> ______________________________________________
> R-devel@stat.math.ethz.ch mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel


[Rd] Suggestion: help(<package name>)
Kurt Hornik