Ari, también uso roxygen2 (versión 4.1.0). El siguiente es el final de mi marcado roxygen2 en mi definición de función (gctemplate) hasta el comienzo de la parte real.
#' @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){
...
Conozco el método dontrun de GSee.
En mi técnica, el ejemplo numérico y el texto que explica el ejemplo numérico son comentarios. Utilizo sangría para diferenciar estos dos; Observe que hay 1 sostenido y 2 sostenidos respectivamente después de "#". Siempre uso la técnica anterior "# '## / #' #" en mis paquetes. El usuario tiene que realizar la operación de copiar y pegar siempre que quiera probar la función. Esta técnica es, según yo, más paralela al clásico bombardeo de comentarios de la filosofía de codificación de software.
?example
y Writing R Extensions