繁体   English   中英

如何为 r 包记录数据集?

[英]How to documenting datasets for a r-package?

我正在尝试为 r 包记录数据集,如http://r-pkgs.had.co.nz/data.html#documenting-data 每个数据都包含在单个向量中,我在每个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’

我做错了什么?

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

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

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

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM