Peut-Roxygen ignorer les fonctions non-utilisateur?
Question
Je viens juste de commencer à jouer avec le paquet roxygen
et j'ai très heureux des résultats obtenus jusqu'à présent. Cependant, je me demandais, est-il un moyen de spécifier à roxygen
qu'il doit ignorer certaines fonctions qui ne sont pas accessibles à l'utilisateur?
Plus précisément, je préfère ne pas avoir un fichier .Rd
pop-up parce que je suis à l'aide du crochet .onLoad()
dans mon paquet. Cette fonction est déjà documentée dans le paquet base
donc il n'y a aucune raison pour moi de re-documenter.
La solution
Eh bien, j'ai finalement trouvé et parcouru la liste Roxygen-devel R-Forge voir quand ce sera mis en œuvre, et il semble être déjà dans la version de Roxygen qui est sur CRAN. La clé est de spécifier use.Rd2=TRUE
lorsque vous appelez roxygenize()
. Dans ce mode, Roxygen sautera la création de la documentation pour toutes les fonctions qui ne sont pas précédés de commentaires Roxygen.
Autres conseils
est sur leur liste à faire - dans la prochaine version, seules les fonctions avec la documentation roxygen créent des fichiers de l'homme.
Utilisez le champ mot-clé interne ( i.e.. @keywords internal
) pour supprimer la fonction de la documentation et de le rendre disponible pour les utilisateurs expérimentés.
Source:. roxygen2 vignette