如何不运行使用roxygen2的例子?

我现在正在编写一个地理编码function ,它依赖于Bing地图密钥。 显然,我宁愿不发表我的,例子失败,没有一个。

如何包含用户手动运行的示例,但在R CMD check过程中没有执行?

    4 Solutions collect form web for “如何不运行使用roxygen2的例子?”

    使用\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) #'} 

    对于使用@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 

    阿里,我也用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个锐利的。 我总是在我的包中使用上面的“#”## /#“#”技术。 只要他/她想testing该function,用户就可以复制粘贴操作。 根据我的说法,这种技术与软件编码哲学的经典评论轰炸更加平行。

    你可以在你的例子中使用\donttest{} 。 代码将在您的文档中提供,但不会通过R CMD Check进行testing。

    有关更多信息 – > ?example

     #' @example \donttest{ 2^2 } 

    这个2 ^ 2在运行devtools::check()时不会运行

    在判断之前自己检查一下。 🙂