[Rd] help(PackageName)

Peter Dalgaard BSA p.dalgaard@biostat.ku.dk
12 Jun 2001 16:03:20 +0200

Martin Schlather <Martin.Schlather@uni-bayreuth.de> writes:

> Dear R Core Team,
> I'm wondering whether it is useful that every package should allow 
> for help(PackageName), giving some general information about the 
> package (more/nicer than library(help=PackageName)). This man page 
> may include some mathematical or statistical background, or contain 
> a guideline for the package.

help(nlme) would be ambiguous then. 

help(package=nlme) already works, same as library(help=nlme). 

I suppose we could make it a convention to have each package contain
an Overview entry so that help(Overview, package=nlme) would do what
you want (or even help(Overview, nlme) if we switch the arguments
around), but someone would have to write those pages....

   O__  ---- Peter Dalgaard             Blegdamsvej 3  
  c/ /'_ --- Dept. of Biostatistics     2200 Cph. N   
 (*) \(*) -- University of Copenhagen   Denmark      Ph: (+45) 35327918
~~~~~~~~~~ - (p.dalgaard@biostat.ku.dk)             FAX: (+45) 35327907
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-devel-request@stat.math.ethz.ch