Ari, j'utilise aussi roxygen2 (version 4.1.0). Ce qui suit est la fin de mon balisage roxygen2 dans ma définition de fonction (gctemplate) jusqu'au début de la partie réelle.
#' @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){
...
Je connais la méthode dontrun de GSee.
Dans ma technique, l'exemple numérique et le texte expliquant l'exemple numérique sont tous deux des commentaires. J'utilise l'indentation pour faire la différence entre ces deux; Notez qu'il y a respectivement 1 dièse et 2 dièses après "# '". J'utilise toujours la technique "# '## / #' #" ci-dessus dans mes paquets. L'utilisateur est laissé à l'opération de copier-coller chaque fois qu'il veut tester la fonction. Cette technique est, selon moi, plus parallèle au bombardement de commentaires classique de la philosophie de codage logiciel.
?example
et Writing R Extensions