Posizione dei file quando si utilizza il tag @example con roxygen2

Question

Quando si documenta una funzione con roxygen2 è possibile inserire esempi in un file separato.

vedere qui: http://r-pkgs.had.co.nz/man.html "Invece di includere esempi direttamente nella documentazione, è possibile metterli in file separati e utilizzare @example percorso/relativo/a/packge/root per inserirli nella documentazione."

e qui: http://roxygen.org/roxygen2-manual.pdf

esempio

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

La mia domanda è: quale percorso deve essere utilizzato per memorizzare i file di esempio R?

Answer 1

La posizione appropriata per gli esempi utilizzati nel roxygen è:

linea

inst/examples/ 

Il roxygen quindi dovrebbe essere:

#' @example inst/examples/add.R 

---

È questa buona pratica? Credo che sia, dal momento che:

• Si rende più facile da eseguire, modificare e testare gli esempi, mentre lo sviluppo
• Rende possibile (in linea di principio, almeno) di riutilizzare gli esempi in luoghi diversi nella documentazione, ad es nella vignetta