包的帮助索引页面是否可定制？答案

【问题标题】：Is a package's help index page customizable?包的帮助索引页面是否可定制？
【发布时间】：2021-02-22 16:51:27
【问题描述】：

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

help(package=stats)

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

这个索引页可以自定义吗？

我正在使用roxygen2，并且希望能够通过@family 对功能进行分组。

【问题讨论】：

标签： r roxygen2

【解决方案1】：

参见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

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

【讨论】：

虽然不是我的问题的确切答案（是否可以自定义索引，而不是“包概述”页面），但我怀疑这是可能的（并且可以说更好，因为 ?mypackage 可能是比help(package=mypackage) 更常用）。