如何为R包添加包级文档（非函数文档）以支持help()/?查询

你需要实现的?包名查询包级说明的效果，需要生成专门的包级Rd帮助文档，具体配置步骤如下：

步骤1：新建包级文档配置文件 #

在你的R包项目的R/目录下，新建一个命名为cats-package.R的文件，填入以下roxygen2注释内容：

#' cats: 你的包的功能简介
#'
#' 这里可以补充包的详细介绍，比如核心功能、适用场景、设计逻辑等
#'
#' @docType package
#' @name cats
#' @aliases cats cats-package
#' @author 作者名称 \email{你的联系邮箱@example.com}
#' @references 相关参考资料说明
#' @seealso 其他相关函数或包的指引
NULL

注意：末尾的NULL是roxygen2生成包级文档的必要占位符，不能删除。

步骤2：生成帮助文件并重装包 #

• 在包项目根目录的控制台中运行devtools::document()，工具会自动根据上述配置在man/目录下生成对应的cats-package.Rd标准帮助文件
• 运行devtools::install()重新安装更新后的包

配置完成后，输入?cats即可调出和dplyr等包格式一致的标准包级帮助页。

常见问题说明 #

• 之前添加的vignette、README无法通过?查询，是因为?调用的是R内置Rd格式的帮助系统，和 vignette、README属于不同的文档体系
• 之前通过Index入口看到的简易帮助页是R自动生成的默认索引，不属于自定义的标准包级文档

内容的提问来源于stack exchange，提问作者rempsyc