R包中如何引用/data文件

Question

我已经向 CRAN 提交了一个 R 包。我需要包含我包含在 /data 目录下的示例 .csv 文件。

为了让 R CMD 检查通过，我必须让 .Rd 文件中的示例引用数据 .csv 文件，如下所示

 pkg-function(system.file("data", <csv file>, package = pkg-name),par1) -- (1)

使用此格式可以通过 R CMD 检查，并且在安装包后也能正常工作，而不是实际路径名。

但我希望用户能够以如下简单的方式引用 .csv 文件

pkg-function(path-to-file, par1) -- (2)

由于 .Rd 文件中的示例采用形式 (1)，这会使用户感到困惑。

是否有一种干净的方法来调用示例 (.Rd) 中的包函数作为格式 (2)

Answer 1

我会建议您改变预期。与其试图找到一种方法来用尽可能少的代码制作一个清晰明显的示例，也许您可以编写更多带有注释的代码来说明您在做什么。

例如：

#* retrieve the file path of a data file installed with
#* [your package's name] 
#* see '?system.file' for details.
Path <- system.file (...)

#* execute function
pkg-function (Path, par1)

R包中如何引用/data文件

How to refer to /data files in R package

r

package

cran