我很清楚当代码直接位于 roxygen 注释中时如何让 roxygen 不运行示例。但是,某些示例可能有点冗长,或者您希望将示例编译在示例目录中。在这种情况下@example file_path
工作正常,但我不知道如何让 roxygen 不运行(即\dontrun
) 这个例子file.
这被承认非常类似于this https://stackoverflow.com/questions/12038160/how-to-not-run-an-example-using-roxygen2问题,但评论显示这个问题没有得到解答。
test.R
# 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")
}
测试示例.R
test()
我怎样才能让前一种方法发挥作用?
看来我可以通过使用 roxygen2 风格的注释来完成此任务\dontrun{}
示例文件中的块。这绕过了限制米哈尔的回答 https://stackoverflow.com/a/32888259/1380598.
创建一个如下所示的示例文件:
#' \dontrun{
test()
#' }
更可靠的是,您可以将示例包装在if(interactive()) {}
块,它不会在检查期间运行,但允许您手动运行示例。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)