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

From: Kurt Hornik <Kurt.Hornik_at_wu-wien.ac.at>
Date: Tue 07 Jun 2005 - 11:10:42 GMT

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



R-devel@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Tue Jun 07 21:13:59 2005

This archive was generated by hypermail 2.1.8 : Mon 20 Feb 2006 - 03:21:06 GMT