roxygen2 如何不运行示例文件

Question

我很清楚当代码直接在 roxygen 注释中时如何让 roxygen 不运行示例。但是，某些示例可能有些冗长，或者您希望将示例编译在示例目录中。在这种情况下 @example file_path工作正常，但我不知道如何让 roxygen 不运行(即 \dontrun )示例 文件 .

这被承认与 this 非常相似问题，但评论表明这个问题没有得到解答。

测试

# this does not work
#' @title test_fun
#' @example \dontrun{examples/test_example.R}
test <- function(){
    print("hello")
}

# this does
#' @title test
#' @examples 
#' \dontrun{
#' test()
#' }
test <- function(){
    print("hello")
}

test_example.R

test()

我怎样才能让以前的方法发挥作用？

Answer 1

似乎我可以通过对 \dontrun{} 使用 roxygen2 样式的注释来完成此操作。块在示例文件中。这绕过了 Michal's answer 中的限制.

创建一个如下所示的示例文件:

#' \dontrun{
test()
#' }

更可靠的是，您可以将示例包装在 if(interactive()) {} 中。块，它不会在检查期间运行，但允许您手动运行示例。