如何使用roxygen2为自定义R包创建包级帮助文档？

要实现类似base包的包级帮助页面，按以下步骤操作：

• 创建专用文档文件：在包的R目录下新建一个命名为{你的包名}-package.R的文件（比如包名为mypkg，则文件名为mypkg-package.R）。

• 编写roxygen2文档标签：在该文件中添加包级文档的roxygen2注释，示例如下：

#' @docType package
#' @name mypkg-package
#' @title 我的自定义工具包
#' @description 本包提供XX领域的便捷工具函数，涵盖数据处理、可视化等功能。
#' @details 包内包含3个核心模块：数据清洗模块、统计分析模块、结果可视化模块，各模块下的函数可协同完成完整工作流。
#' @author 你的姓名
#' @keywords package
#' @examples
#' # 加载包
#' library(mypkg)
#' # 快速示例：使用核心函数
#' my_core_function(data = sample_data)
NULL

注意：文件末尾必须保留NULL，因为该文件无需导出任何对象，仅用于生成包级文档。

• 生成文档：运行devtools::document()（或在RStudio中点击Build菜单的「Document」按钮），roxygen2会自动将注释转换为包级帮助文件。

• 验证效果：重启R会话，加载你的包（library(mypkg)），执行help("mypkg")或?mypkg，即可看到完整的包级帮助页面。

额外提示：你可以根据需求添加更多roxygen2标签，比如@seealso关联包内核心函数、@references添加参考文献等，丰富帮助内容。

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