如何让R包中的data2继承data1的roxygen2文档？

方法1：使用roxygen2片段引用（推荐） #

这种方法把公共列的文档抽成可复用片段，在多个数据集中引用，灵活性最高。

步骤1：创建公共列描述片段 #

在包内新建R/col_descriptions.R文件，存放所有数据集的公共列描述：

#' @keywords internal
#' @section 公共列描述:
#' \describe{
#'    \item{name}{学生姓名}
#'    \item{school}{学校名称}
#'    \item{grade}{学生年级}
#' }
"col_descriptions"

• @keywords internal 确保该片段不会被单独生成对外文档

步骤2：修改data1的文档 #

直接引用公共片段，无需重复编写列描述：

#' School Enrollment Data
#' 
#' 2018-2019学年的学校招生数据。
#' 
#' @format 一个包含100行3列的tibble:
#' <<col_descriptions>>
#' @source xyz
"data1"

步骤3：编写data2的文档 #

引用公共片段后，补充新增列的描述即可：

#' School Enrollment Detail Data
#' 
#' 2018-2019学年的学校招生详细数据，包含`data1`的所有列并新增学生性别与运动偏好信息。
#' 
#' @format 一个包含75行5列的tibble:
#' <<col_descriptions>>
#' \describe{
#'    \item{gender}{学生性别}
#'    \item{sport}{学生偏好的运动项目}
#' }
#' @source xyz 和 abc
"data2"

方法2：使用@inherit标签继承部分文档 #

如果不想创建额外片段文件，可以通过@inheritParams继承data1的列描述，再补充新增信息：

#' School Enrollment Detail Data
#' 
#' 2018-2019学年的学校招生详细数据，包含`data1`的所有列并新增学生性别与运动偏好信息。
#' 
#' @format 一个包含75行5列的tibble，基础列描述继承自`data1`，新增列如下：
#' \describe{
#'    \item{gender}{学生性别}
#'    \item{sport}{学生偏好的运动项目}
#' }
#' @inheritParams data1
#' @source xyz 和 abc
"data2"

• 注意：这种方式会把data1的列描述放到文档的参数部分，而非严格保留在@format的\describe块中，适合对文档结构要求不严格的场景。

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