将部分添加到R包的帮助/文档中

Geg*_*naV 7 r devtools ggplot2 roxygen2 r-package

一些R包(例如 ggplot2,dplyr,devtools等)已按字母顺序题为他们的帮助/文档和链接到那些部分一栏(如下图红色箭头表示)的部分.其他包(例如RcmdrMisc)没有.

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

ggplot2的帮助

roxygen2用于文档.

42-*_*42- 2

在编写 R 扩展文件(包含在 CRAN 的每个 R 副本中)中有一小部分是关于 INDEX 文件的:

1.1.4 索引文件

可选文件 INDEX 为包中每个足够有趣的对象包含一行,给出其名称和描述(可能不包括通常不显式调用的打印方法等函数)。通常,此文件会丢失,并且从源安装时会从文档源(使用tools::Rdindex())自动生成相应的信息。

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