@ roxy2 ile @ örnek etiketi kullanılırken dosyaların konumu

Question

Bir işlevi roxygen2 ile belgelendirirken, örnekleri ayrı bir dosyaya yerleştirmek mümkündür.

Buraya bakın: http://r-pkgs.had.co.nz/man.html "Yerine belgelerinde doğrudan örnekler de dahil olmak üzere, ayrı dosyalar koyun ve dokümantasyon içine eklemek için @example yolu/akraba/için/packge/root kullanabilir." Burada

ve: http://roxygen.org/roxygen2-manual.pdf

ör

#' Add together two numbers. 
#' 
#' @param x A number. 
#' @param y A number. 
#' @return The sum of \code{x} and \code{y}. 
#' @example /path/to/example/add.R 
add <- function(x, y) { 
    x + y 
} 

Soruma şu soru geliyor: Örnek R dosyalarını saklamak için hangi yol kullanılmalı?

Answer 1

sizin roxygen kullanılan örnekler için uygun bir yerdir:

inst/examples/ 

roxygen hattı daha sonra olmalıdır:

#' @example inst/examples/add.R 

---

bu iyi bir uygulama mı? Bu daha kolay koşmak, değiştirmek ve Bu mümkün (prensip olarak, en azından) farklı yerlerde örnekler yeniden kullanmak yapar

gelişmekte iken örneklerini test etmek için yapar

• : Ben beri olduğunu düşünüyorum dokümantasyonda, örneğin