R和roxygen2:如何在inst / extdata中记录数据文件?

时间:2016-02-12 22:25:40

标签: r documentation roxygen2

我想要使用我正在创建的包分发一些数据文件。我已将文件放在inst / extdata中。如何以及在何处使用roxygen2记录这些文件?

1 个答案:

答案 0 :(得分:0)

我仍然不确定最佳做法,但遵循rawr的建议,这就是我所做的:

  • 创建了一个文件R / extdata.R
  • 记录我在inst / extdata中的每个文件,如下所示:

(忽略这一行:显然我需要一些文字,以便下面的内容变成代码块。)

#' Dataset foo
#'
#' This is a dataset containing stuff.
#'
#' @name raw_datasetName
#'
#' @section datasetName.csv:
#'
#' This data is used in thisFunction().
NULL