包的帮助索引页可自定义吗？

Question

help()函数允许我们看到一个包含包中所有函数的索引：

help(package=stats)

如果包非常大，帮助页将自动按字母顺序细分，并按首字母链接到每个部分(如stats)。较小的包将所有功能按字母顺序排列在一起。

此索引页可自定义吗？

我正在使用roxygen2，并且希望能够根据它们的@family对函数进行分组。

Answer 1

见R包第10.6节：

您可以使用roxygen为整个包提供帮助页。您需要记录NULL，然后手动将其标记为@docType包和@name。这也是一个很好的地方使用@节标记将页面划分为有用的类别。

只需创建一个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

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