如何为R包中的多个数据集分别添加对应帮助说明页

以下操作默认你使用roxygen2框架生成R包文档，和你当前制作单个数据集文档的逻辑一致，仅需要补充其余数据集的文档块即可：

1. 确认数据集存储规范 #

• 所有.RData格式的数据集全部存放在包根目录的data/文件夹下
• 每个.RData文件仅存储1个数据集对象，且文件名和数据集对象名完全一致

2. 编写多数据集文档块 #

在包的R/目录下新建一个专门用于存储数据集文档的R脚本，命名为datasets.R即可，按如下格式为每个数据集编写独立的roxygen2文档块：

#' UCDP武装冲突数据集
#'
#' 此处填写UCDP数据集的详细说明，包含数据来源、时间覆盖范围、适用场景等信息
#'
#' @format 包含xxxx行xxxx列的数据框，各变量含义如下：
#' \describe{
#'   \item{conflict_id}{冲突唯一识别码}
#'   \item{year}{冲突发生年份}
#'   \item{region}{冲突发生区域}
#'   \item{casualty}{伤亡人数统计}
#' }
#' @source UCDP官方公开数据集
"UCDP"

#' 第二个数据集名称
#'
#' 第二个数据集的详细描述
#'
#' @format 包含xxxx行xxxx列的数据框，各变量含义如下：
#' \describe{
#'   \item{var1}{变量1的具体含义}
#'   \item{var2}{变量2的具体含义}
#' }
#' @source 第二个数据集的来源说明
"dataset2"

#' 第三个数据集名称
#'
#' 第三个数据集的详细描述
#'
#' @format 包含xxxx行xxxx列的数据框，各变量含义如下：
#' \describe{
#'   \item{var1}{变量1的具体含义}
#'   \item{var2}{变量2的具体含义}
#' }
#' @source 第三个数据集的来源说明
"dataset3"

# 剩余第4、第5个数据集按照上述格式依次补充即可

3. 生成多份帮助页 #

所有文档块编写完成后，运行如下命令自动生成帮助文档：

devtools::document()

运行完成后会自动在man/目录下生成每个数据集对应的.Rd格式帮助文件，重新安装你的R包后，就能在帮助面板的数据集分类下看到所有5个数据集的入口，和dslabs包的展示效果完全一致。

注意事项 #

• 每个roxygen文档块末尾引号内的名称，必须和对应数据集的对象名完全一致，否则无法匹配生成对应帮助页
• 不要给数据集文档添加@export标签，数据集默认不需要导出，加载包后通过data(数据集名)即可调用

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