Skip to content

grouping list of objects in the help system

4 messages · Duncan Murdoch, Gábor Csárdi, Adrian Dusa

Original
Adrian Dusa
# 
Dear list,

I've noticed for some packages the Index file in the help system has a
single list of objects (arranged alphabetically), while for other
packages this list is offered separately by letters... presumably when
the number of help objects is high.

Is there a way to manually split the help objects into categories?

For example, I would like to have an alphabetic order for the group
"datasets" and another alphabetical order for the group "functions".

Needless to say that I've tried to read everything I could on this
topic (especially "Writing R Extensions"), even looked closely on
different package sources, but I haven't noticed anything special.

Thanks,
Adrian
Duncan Murdoch
#
On 11/07/2014 12:11 PM, Adrian Du?a wrote:
You have a little bit of control of the order of topics in the PDF 
reference manual (e.g. see the lattice package), but the HTML help page 
is produced by R, not by you, and is presented in a standard 
alphabetical order.  I would object quite strongly to people messing 
with that.

Duncan Murdoch
Gábor Csárdi
# 
Depending on what you want, you might be interested in the staticdocs
package: https://github.com/hadley/staticdocs

If you want to build your own HTML docs, and put it online somewhere,
then it could be good enough for you.

Gabor
On Fri, Jul 11, 2014 at 12:11 PM, Adrian Du?a <dusa.adrian at unibuc.ro> wrote:
Adrian Dusa
# 
On Fri, Jul 11, 2014 at 10:01 PM, Duncan Murdoch
<murdoch.duncan at gmail.com> wrote:
I understand...
Thanks G?bor as well, already knew about Hadley's (very useful) set of
packages but I thought there was something I was missing in the base R
package structure.

Best,
Adrian