如何用roxygen2生成R自定义函数avglist的可调用帮助文档？

问题根源 #

roxygen2注释不能直接被R识别为帮助文档，它需要被转换为R官方的.Rd格式帮助文件，且只有当函数属于一个R包时，help系统才能加载这些文档。直接在单脚本中编写roxygen注释，R无法自动解析为可访问的帮助信息。

具体解决步骤 #

1. 搭建R包基础结构 #

创建如下目录结构（以包名mypackage为例）：

mypackage/
├── DESCRIPTION
└── R/
    └── avglist.R

将包含roxygen注释的函数代码放入R/avglist.R文件中。

2. 编写DESCRIPTION文件 #

在包根目录的DESCRIPTION文件中填入包的基础信息，示例如下：

Package: mypackage
Title: Compute Average of Numbers in Specified Range
Version: 0.1.0
Author: Your Name
Maintainer: Your Name <your.email@example.com>
Description: A utility package to calculate the average of numeric values within an exclusive range.
License: MIT
Encoding: UTF-8
LazyData: true

3. 生成帮助文档 #

打开R，切换工作目录到包根目录，执行以下操作：

# 加载roxygen2包
library(roxygen2)
# 生成帮助文档和NAMESPACE文件
roxygenize()

# 若安装了devtools包，可使用更简便的命令：
# library(devtools)
# document()

执行后，包目录会自动生成man/avglist.Rd帮助文档文件，以及管理包导出对象的NAMESPACE文件。

4. 安装并加载包 #

执行命令安装本地包并加载：

# 安装本地包
install.packages(".", repos = NULL, type = "source")
# 加载包
library(mypackage)

5. 查看帮助文档 #

现在运行以下命令即可正常查看函数帮助：

?avglist
# 或者
help(avglist)

临时调试方案（无需正式安装包） #

若仅需临时测试不想安装包，可使用devtools工具快速加载：

1. 先安装devtools：install.packages("devtools")
2. 在包根目录运行：devtools::load_all()
3. 直接调用?avglist查看帮助

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