簡體   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