包的帮助索引页面是否可以自定义？

如何解决包的帮助索引页面是否可以自定义？

help() 函数允许我们查看包含包中所有函数列表的索引：

help(package=stats)

如果包非常大，帮助页面将自动按字母顺序分解，并按首字母链接到每个部分（如 stats 的情况）。较小的包将按字母顺序将所有功能放在一起。

此索引页是否可自定义？

我正在使用 roxygen2，并且希望能够按其 @family 对函数进行分组。

解决方法

参见 R Packages 的 10.6 节：

您可以使用 roxygen 为整个包提供帮助页面。

您需要记录 NULL，然后使用 @docType 包和 @name 手动标记它。这也是使用@section 标记将页面划分为有用类别的绝佳位置。

只需创建一个 mypackage.R 文件，并将上述 Roxygen 标签应用于 NULL：

#' Mypackage: A package I created
#'
#' MyPackage has different families of functions described below
#' 
#' @section Some functions:
#' * [mysum()] 
#' * [myprod()]
#' 
#' @section Other functions:
#' * [other()]
#' * [foo()]
#'
#' @docType package
#' @name mypackage
NULL

方括号 [] 允许创建指向包功能的链接。