Làm thế nào để không chạy một ví dụ bằng cách sử dụng roxygen2?

Tôi đang viết một chức năng mã hóa địa lý dựa vào việc có Khóa bản đồ Bing. Rõ ràng là tôi không muốn xuất bản của tôi, và các ví dụ không thành công mà không có một.

Làm cách nào để đưa vào một ví dụ để người dùng chạy theo cách thủ công, nhưng không thực thi nó trong thời gian đó R CMD check?

Sử dụng \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)
#'}

Bạn có thể sử dụng \donttest{}ví dụ của mình. Đoạn mã sẽ được cung cấp trong tài liệu của bạn, nhưng sẽ không được kiểm tra bằng Kiểm tra R CMD.

Để biết thêm thông tin -> ?example

#' @example
\donttest{
    2^2
    }

2 ^ 2 này sẽ không chạy khi bạn chạy devtools::check()

Hãy tự mình kiểm tra trước khi đánh giá. :)

Đối với những người đang sử dụng @example path/to/example.Rthay vì @examplesthẻ, bạn có thể sử dụng \dontrunmôi trường trực tiếp trong example.Rtệp. Ví dụ

# 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

Ari, tôi cũng sử dụng roxygen2 (phiên bản 4.1.0). Phần sau là phần đánh dấu roxygen2 trong định nghĩa hàm (gctemplate) của tôi cho đến đầu phần thực.

#' @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){
...

Tôi biết phương pháp dontrun của GSee.
Trong kỹ thuật của tôi, ví dụ số và văn bản giải thích ví dụ số đều là chú thích. Tôi sử dụng thụt lề để tạo sự khác biệt giữa hai điều này; Chú ý có 1 dấu sắc và 2 dấu sắc tương ứng sau "# '". Tôi luôn sử dụng kỹ thuật "# '## / #' #" ở trên trong các gói của mình. Người dùng được để lại thao tác sao chép-dán bất cứ khi nào họ muốn kiểm tra chức năng. Kỹ thuật này - theo tôi - song song hơn với sự bắn phá bình luận cổ điển của triết lý mã hóa phần mềm.