R和roxygen2 : How to document data files in inst/extdata?

Question

我有一些数据文件要与我正在创建的包一起分发。我已将文件放在 inst/extdata 中。我如何以及在哪里使用 roxygen2 记录这些文件？

Answer 1

我仍然不确定什么是最佳实践，但遵循 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