2016-02-27 29 views
5

一些R包他们的帮助/文档和链接到那些部分酒吧中(例如,ggplot2dplyrdevtools等)已按字母顺序有权段(由下图红色箭头所示)。其他包(例如,RcmdrMisc)没有。添加章节至R包的帮助/文档

如何将这些元素添加到可能的R软件包的帮助中?

ggplot2 help

我用roxygen2的文档。

+0

好问题!我想这些软件包的源代码可以给出一个答案(如果没有人知道它的话)。 –

+0

据我所知,这些索引文件是自动生成的。至少,我的软件包总是有它们,但我从来没有写过它们。我一直认为这些字母会自动添加,一旦函数列表变得足够长。但我可能是错的。 – Stibu

+0

我在GitHub上研究了几个包的结构,但没有找到如何制作这个按字母顺序排列的索引。 – Vilmantas

回答

1

在写作R附加文件(包括从CRAN R的每个副本)是与INDEX文件的一小部分:

1.1.4索引文件

可选的文件索引包含一个为包中每个足够感兴趣的对象提供一行,并给出它的名称和描述(通常不会显式调用打印方法等功能)。通常,该文件丢失,并且从源文件安装时会自动从文档来源生成相应的信息(使用tools::Rdindex())。

当包有索引文件时,HTML代码位于html文件夹中。

+0

我发现'我的软件包的安装版本中的'html'文件夹,但我仍然不明白,如何使部分。函数'tools :: Rdindex()'负责在安装包的过程中使用索引创建HTML文件? – Vilmantas

+0

这是我对通常过程的理解。自动魔法。 –