Re: [Rd] why is \alias{anRpackage} not mandatory?

From: Duncan Murdoch <murdoch_at_stats.uwo.ca>
Date: Tue, 07 Oct 2008 09:46:08 -0400

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



R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Tue 07 Oct 2008 - 13:49:47 GMT

Archive maintained by Robert King, hosted by the discipline of statistics at the University of Newcastle, Australia.
Archive generated by hypermail 2.2.0, at Tue 07 Oct 2008 - 15:30:18 GMT.

Mailing list information is available at https://stat.ethz.ch/mailman/listinfo/r-devel. Please read the posting guide before posting to the list.

list of date sections of archive