如何用roxygen2为R包创建独立功能说明帮助页？

完全可行，roxygen2支持创建不绑定任何函数的帮助页，两种常用实现方法如下：

方法1：包级整体说明页 #

适合用来介绍包的核心功能、设计思路等，可在包内新建一个R脚本（比如R/package-docs.R），添加以下roxygen注释即可：

#' 我的自定义R包
#'
#' 这里详细描述包的核心功能、适用场景、使用流程等内容，作为vignettes的轻量化替代方案。
#' @docType package
#' @name mypackage-package
#' @title 我的自定义R包
#' @description 专注于XX领域的工具包，提供YY、ZZ等便捷功能。
#' @details 补充更细致的使用注意事项、依赖说明或设计背景。
#' @author 你的姓名
#' @keywords package
NULL

生成后用户可通过?mypackage或?mypackage-package访问该帮助页，它会自动出现在CRAN的PDF手册中。

方法2：特定主题帮助页（如包选项说明） #

如果要做类似survey包surveyoptions那样的独立主题帮助页（比如包配置选项、使用技巧），可以用以下方式：

#' 我的R包配置选项说明
#'
#' 这里集中说明包的所有可配置选项、默认值及修改方式。
#' @docType help
#' @name mypackage-options
#' @title 我的R包配置选项
#' @description 自定义包行为的参数说明，帮助用户按需调整。
#' @section 可用选项:
#' - `mypackage.verbose`: 默认值`FALSE`，控制是否输出详细运行日志
#' - `mypackage.default_path`: 默认值`getwd()`，设置文件操作的默认路径
#' @examples
#' # 查看当前选项
#' getOption("mypackage.verbose")
#' # 修改选项
#' options(mypackage.verbose = TRUE)
NULL

运行devtools::document()后，用户输入?mypackage-options就能直接打开这个帮助页，效果和手动编写.Rd文件完全一致。

注意事项 #

• 确保注释所在的R脚本中没有定义与@name同名的函数，避免冲突
• 无需手动创建.Rd文件，roxygen2会自动在man/目录生成对应文件
• 这类帮助页会被CRAN的PDF手册收录，和常规函数帮助页格式统一

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