From huber at ebi.ac.uk  Tue Jun  7 13:59:34 2005
From: huber at ebi.ac.uk (Wolfgang Huber)
Date: Tue Jun  7 13:19:24 2005
Subject: [Rd] Suggestion: help(<package name>)
In-Reply-To: <17061.32946.976628.961120@beren.wu-wien.ac.at>
References: <42A57F5D.7080505@maths.lth.se>
	<17061.32946.976628.961120@beren.wu-wien.ac.at>
Message-ID: <42A58C26.2060700@ebi.ac.uk>

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


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