如何在R包

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)