使用 roxygen2 忽略脚本

Question

我正在编写一个 package，它在服务器上做了一些工作。 我有一个更新表格的脚本，但我的意图不是手动和不频繁地运行它。 这不是 function 需要 go 进入命名空间或任何东西，只是一个脚本。

问题是，当我调用roxygen2::roxygenize()时，它会运行此脚本并需要一段时间才能运行，这在我尝试开发交互式功能时非常烦人。 我知道我可以在文档中的示例周围添加\donotrun{} ，但这在这种情况下不太有意义。 有没有办法告诉 roxygen 不要费心执行这个？

我考虑将其设为 function 以便执行它只会定义 function 主体，但这似乎有点横向。

任何建议都会很棒

Answer 1

对于新访问者，这不是 function 的 roxygen 文档中的代码； 为此，最好用\donotrun将其包围，如

#' @examples
#' \donotrun{
#' something_goes_here()
#' }
myfunction <- function(...) {

但是，在这种情况下，它包含 package 本身中的一些文件。

1. 您放置在./inst/目录中的文件与软件包一起安装，但不假定它们是 R 脚本（或其他任何东西）。 对此的权威参考开始于“编写 R 扩展” ， 第 1.1.5 节 Package 子目录。 这将在通过install.packages(...)安装 package 的每台计算机上安装文件。

2. If you want something within the package source but not to be installed with the package itself, I suggest you place a file in the root of the package named .Rbuildignore (ref: same link, now section 1.3.2 Building package tarballs). 与这些模式匹配的文件不会包含在 package tarball 中。 是否将实际文件放在./inst/或其他任何地方完全取决于您：如果它位于.Rbuildignore文件中，那么它将从 tarball 中排除（因此最终用户可以看到/找到）。