[Rd] Suggestion: help(<package name>)
Henrik Bengtsson
hb at maths.lth.se
Tue Jun 7 13:05:01 CEST 2005
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?
Henrik Bengtsson
More information about the R-devel
mailing list