如何记录 r 包的数据集？答案

【问题标题】：How to documenting datasets for a r-package?如何记录 r 包的数据集？
【发布时间】：2020-06-20 19:31:06
【问题描述】：

我正在尝试为 r-package 记录数据集，如http://r-pkgs.had.co.nz/data.html#documenting-data。每个数据都包含在单个向量中，我在每个 data1.R 中都写了这样的内容：

#'
#' @format 具有一列的单个向量：
＃' @例子
#' \不要运行{
#'数据1
#' }
“数据1”

他们，我把每个文档的“.R”文件放在了mypackage/R文件夹中。但是，当我参加 CRAN 时，他们报告了以下警告：

Undocumented code objects:
  ‘data1’ ‘data2’ ‘data3’ ‘data4’ ‘data5’ ‘data6’
Undocumented data sets:
  ‘data1’ ‘data2’ ‘data3’ ‘data4’ ‘data5’ ‘data6’

我做错了什么？

【问题讨论】：

您是否启动了包文档以生成 .Rd 文件？
我不为数据文件生成 .Rd 文件，只为函数文件生成。我认为文件夹 R/ 上的 .R 文件是相当的。

标签： r package cran

【解决方案1】：

应记录所有包对象以避免出现警告。
你应该启动：

devtools::document(roclets = c('rd', 'collate', 'namespace'))

生成与您的数据集关联的 .Rd 文件

【讨论】：