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

From: Wolfgang Huber <huber_at_ebi.ac.uk>
Date: Tue 07 Jun 2005 - 11:59:34 GMT

>>>>>>Henrik Bengtsson writes:
>>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.

But isn't that just what vignettes are there for?

And I think nobody has said that vignettes should be "extensive", and if they end up being so, that is a problem of the package author, and probably would end up being the same with yet another form of documentation.

Best regards

   Wolfgang



Wolfgang Huber
European Bioinformatics Institute
European Molecular Biology Laboratory
Cambridge CB10 1SD
England
Phone: +44 1223 494642
Fax: +44 1223 494486
Http: www.ebi.ac.uk/huber

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

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