Lokalizacja plików przy użyciu tagu @example z roxygen2

Question

Podczas dokumentowania funkcji z roxygen2 możliwe jest umieszczenie przykładów w oddzielnym pliku.

Zobacz tutaj: http://r-pkgs.had.co.nz/man.html "Zamiast umieszczać przykłady bezpośrednio w dokumentacji, możesz umieścić je w osobnych plikach i użyć @przykładu ścieżka/względna/do/pakiet/root, aby wstawić je do dokumentacji."

i tu: http://roxygen.org/roxygen2-manual.pdf

np

#' 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 
} 

Moje pytanie brzmi: jaka ścieżka powinna być używana do przechowywania przykładowych plików R?

Answer 1

odpowiedniej lokalizacji przykłady używane w roxygen brzmi: wtedy

linia

inst/examples/ 

roxygen powinno być:

#' @example inst/examples/add.R 

---

Czy to dobra praktyka? Myślę, że to jest, ponieważ:

• To sprawia, że ​​łatwiej uruchomić, modyfikować i testować przykłady jednoczesnym rozwijaniu
• To sprawia, że ​​jest to możliwe (w zasadzie, co najmniej), aby ponownie użyć tych przykładów w różnych miejscach w dokumentacji, np w winietce