开发R包时如何解决未生成r2.rd文件的检查警告问题

当你的R包中R/r2.R存在函数但man文件夹无对应r2.rd文件，执行R CMD check时出现未文档化的警告，可按以下步骤解决：

1. 给r2函数添加Roxygen注释 #

在r2.R文件的函数定义上方，添加符合Roxygen规范的注释，这是自动生成文档的核心。示例注释结构如下：

#' 计算模型的R平方值
#'
#' 用于统计模型拟合优度的R平方计算，支持线性模型等常见模型类型
#'
#' @param model 已拟合完成的统计模型对象（如`lm()`生成的线性模型）
#' @return 数值型结果，返回模型的R平方值
#' @examples
#' # 示例：基于mtcars数据集计算线性模型的R平方
#' car_model <- lm(mpg ~ wt, data = mtcars)
#' r2(car_model)
#' @export
r2 <- function(model) {
  # 函数核心实现代码
  summary(model)$r.squared
}

• #'开头的行是注释内容，用于生成文档说明
• @export必须添加，否则函数不会被导出到包的命名空间，同时文档生成也会受影响
• @param/@return/@examples分别定义参数说明、返回值说明和使用示例，是用户理解函数的关键

2. 自动生成文档文件 #

在RStudio中，可直接点击右侧Build面板里的Document按钮；或者在控制台执行命令：

devtools::document()

执行后，Roxygen2会自动解析注释，在man文件夹生成对应的r2.rd文件。

3. 验证警告是否消除 #

重新执行R CMD check（或点击RStudio Build面板的Check按钮），检查"missing documentation entries"警告是否消失。

额外注意事项 #

如果是首次在包中使用Roxygen2，需确保包已配置Roxygen相关设置：

• 执行devtools::use_roxygen_md()可自动配置DESCRIPTION文件，启用Markdown格式的文档支持
• 检查DESCRIPTION文件中是否包含类似配置：Roxygen: list(markdown = TRUE)

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