如何使用roxygen2运行示例？

Question

我现在正在编写一个地理编码功能,它依赖于Bing Maps Key.显然我宁愿不发布我的,并且没有一个例子就失败了.

如何包含一个示例供用户手动运行,但没有在执行期间执行R CMD check？

Answer 1

使用 \dontrun{}

#'@examples
#'\dontrun{
#'geocode("3817 Spruce St, Philadelphia, PA 19104")
#'geocode("Philadelphia, PA")
#'dat <- data.frame(value=runif(3),address=c("3817 Spruce St, Philadelphia, PA 19104","Philadelphia, PA","Neverneverland"))
#'geocode(dat)
#'}

Answer 2

您可以使用\donttest{}您的示例.该片段将在您的文档中提供,但不会通过R CMD Check进行测试.

欲了解更多信息 - > ?example

#' @example
\donttest{
    2^2
    }

当你跑步时,这个2 ^ 2将无法运行 devtools::check()

在判断之前先自己检查一下.:)

Answer 3

对于那些正在使用@example path/to/example.R而不是@examples标签的用户，您可以\dontrun在example.R文件中直接使用环境。例如

# example.R
\dontrun{
# this is a long running example
for(i in seq(1, 1e5)) { lm(mpg ~ wt, data = mtcars) }
}

# some other shorter example
2 + 2