Re: [Rd] Package index help file question.

From: Duncan Murdoch <murdoch.duncan_at_gmail.com>
Date: Wed, 01 Aug 2012 13:00:31 -0400

On 01/08/2012 10:10 AM, Damien Georges wrote:
> Dear R developers,
>
> I come to you because nobody was able to answer the following request yet.
>
> I'm developing a release of BIOMOD package called biomod2
> ( https://r-forge.r-project.org/R/?group_id=302).
>
> I'm writing my package helps files and I'm not really satisfied by the
> visual results.
>
> I would like to make subsections in the package "function help index" file.
>
> I would like for example to put all S4 object documentation link
> together, then all the getters & setters functions.. and so on..
>
> Do you know if it's possible to do it?
> Is it possible to define by myself the html/00index.html file that will
> be use to build my package index file?
>
> If it's not possible, how could I add the alphabetic subsections that
> exists in most of packages index help files without raising the 100
> functions' help files?

There isn't any support for either of those things, but R is open source, so you might be able to do it.

The HTML index is created when the package is installed by the tools:::.writePkgIndices function, and is displayed by the tools:::httpd function. You could modify either of those to either install or to just display something different. Or more simply, you could write your own file and replace the 00Index.html file after your package is installed.

Duncan Murdoch



R-devel_at_r-project.org mailing list
https://stat.ethz.ch/mailman/listinfo/r-devel Received on Wed 01 Aug 2012 - 17:05:51 GMT

This quarter's messages: by month, or sorted: [ by date ] [ by thread ] [ by subject ] [ by author ]

All messages

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 Wed 01 Aug 2012 - 17:10:36 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