From murdoch at stats.uwo.ca  Tue Oct  7 15:46:08 2008
From: murdoch at stats.uwo.ca (Duncan Murdoch)
Date: Tue, 07 Oct 2008 09:46:08 -0400
Subject: [Rd] why is \alias{anRpackage} not mandatory?
In-Reply-To: <971536df0810070611y2c31e014rf6056c763e886686@mail.gmail.com>
References: <48E9DE58.6070303@tu-dresden.de> <48E9E9E3.90905@stats.uwo.ca>	
	<48E9FF28.6060207@tu-dresden.de>	
	<f8e6ff050810060559j19623c5ew8f8e3f47811088c0@mail.gmail.com>	
	<48EA15B5.8020800@tu-dresden.de>	
	<f8e6ff050810060655p25baba3bw6ab54af0ef35acfa@mail.gmail.com>	
	<48EA1F2E.1060207@stats.uwo.ca>
	<971536df0810070611y2c31e014rf6056c763e886686@mail.gmail.com>
Message-ID: <48EB6820.1000502@stats.uwo.ca>

On 07/10/2008 9:11 AM, Gabor Grothendieck wrote:
> Some examples are:
> - be able to use brew package or similar alternative in place of Sweave
> - provide a pdf regardless how it was generated
> without ugly workarounds and still let the user get a list of all pdf
> documents in
> one place, e.g.
>   library(help = mypackage)
> should list the vignettes and other pdfs too so its all together and
> there should
> be some facility similar to vignettes() to easily access them.

The inst/doc directory can already have an index.html file to list all 
the documents there.  This will be automatically produced from the 
vignettes if it doesn't exist, but if you have other files, you can 
write it manually.

This shows up in the HTML help system.  It would be better if it showed 
up in all help formats, but there are other ways to do that, e.g. 
creating an Rd help page pointing to those files.

Duncan Murdoch



[Rd] why is \alias{anRpackage} not mandatory?
Duncan Murdoch