如何记录 r 包的数据集？

Question

我正在尝试按照此处 http://r-pkgs.had.co.nz/data.html#documenting-data 记录 r 包的数据集。每个数据都包含在单个向量中，我在每个 data1.R 中写了这样的东西：

#'
#' @format A single vector with one column:
#' @examples
#' \dontrun{
#'  data1
#' }
"data1"

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

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

我做错了什么？

Answer 1

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

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

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

如何记录 r 包的数据集？

How to documenting datasets for a r-package?

r

package

cran