如何删除roxygen为多数据集帮助文件生成的类描述文本？

要删除roxygen2自动添加的类似“An object of class...”的冗余文本，你可以通过以下两种方法实现：

方法一：统一自定义@format并覆盖默认描述 #

在主roxygen块中详细定义@format内容，同时为共享文档的子数据集块添加禁止生成默认描述的配置：

#' Example with multiple data sets
#'
#' A description of the shared datasets: data1, data2, data3 are identical-dimension datasets for demonstration.
#'
#' @format All datasets are data.frame objects with the same structure:
#' \itemize{
#'   \item col1: Numeric values representing XXX
#'   \item col2: Character labels for grouping
#' }
#' @name multi_data
#' @keywords datasets
#' @docType data
#'
"data1"

#' @rdname multi_data
#' @format NULL
"data2"

#' @rdname multi_data
#' @format NULL
"data3"

• 主块的@format会统一展示所有数据集的格式信息，直接替代默认的类描述
• 子数据集块添加@format NULL，禁止roxygen2为单个数据集生成独立的类描述文本

方法二：使用@section组织格式说明 #

用@section Format:替代@format字段，更灵活地组织格式内容，同时自动覆盖默认的类描述：

#' Example with multiple data sets
#'
#' A description of the shared datasets: data1, data2, data3 are identical-dimension datasets for demonstration.
#'
#' @section Format:
#' All datasets follow the same structure:
#' \tabular{ll}{
#'   col1 \tab Numeric values representing XXX \cr
#'   col2 \tab Character labels for grouping
#' }
#' @name multi_data
#' @keywords datasets
#' @docType data
#'
"data1"

#' @rdname multi_data
"data2"

#' @rdname multi_data
"data3"

这种方式下，roxygen2不会生成默认的类描述，只会展示你自定义的@section Format:内容。

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