如何使用roxygen2运行示例？

Question

我现在正在编写一个地理编码功能 ，它依赖于拥有Bing地图密钥。 显然我宁愿不发布我的，并且没有一个例子就失败了。

如何为用户手动运行包含示例，但在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
    }

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

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

Answer 3

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

# 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

Answer 4

阿里，我也使用roxygen2（版本4.1.0）。 以下是我的函数（gctemplate）定义中的roxygen2标记的结束，直到实部的开头。

#' @examples
#' ## List all G-causalities in a VAR system of 5 variables that will be searched in the pattern of 1 
#' ## causer (like-independent) variable and 2 like-dependents conditional on 5-(1+2)=2 of the remaining 
#' ## variable(s) in the system. Variables are assigned to numbers 1 to nvars. 
#' ## "1 2 5 3 4" in the resulting line of gctemplate is to indicate the 
#' ## (conditonal, partial, etc.) G-causality from variable 1 to variables 2 and 5 
#' ## conditonal on variables 3 and 4.
#' # gctemplate(5,1,2)
#' ## The number of all G-causalities to be searched in the above pattern.
#' #dim(gctemplate(5,1,2))[[1]]
#' @importFrom combinat combn
#' @export
gctemplate <- function(nvars, ncausers, ndependents){
...

我知道GSee的dontrun方法。
在我的技术中，数值示例和解释数字示例的文本都是注释。 我用缩进来区分这两者; 请注意，“＃”后分别有1个锐利和2个锐利。 我总是在我的包中使用上面的“＃”## /＃'＃“技术。 每当他/她想测试该功能时，用户就可以进行复制粘贴操作。 根据我的说法，这种技术与软件编码哲学的经典评论轰炸更为平行。