Je voudrais créer une documentation pour mon code R. Le code fait partie d'un projet R mais pas d'un paquet. Est-il possible que je puisse afficher la documentation pour le code qui n'est pas dans un paquet en utilisant le visualiseur d'aide intégré sans créer un paquet complet?Créer une documentation pour un projet R
Vous pouvez utiliser des commentaires de style Roxygen au-dessus de vos fonctions si vous ne parvenez pas à conserver directement votre documentation dans les fichiers de code. Vous ne seriez pas facilement en mesure de visualiser votre documentation en utilisant la syntaxe typique ?your_function cependant. Il pourrait y avoir un moyen de contourner cela avec quelques hacks pour générer la documentation et les placer quelque part dans le chemin de recherche d'aide, mais cela semble plus de travail que nécessaire.
Si vous souhaitez inclure la documentation de style roxygen2 dans la fonction, vous pouvez obtenir la belle syntaxe ?your_function pour afficher la documentation si vous souhaitez charger le package docstring. C'est un paquet que j'ai écrit à peu près exactement pour votre cas d'utilisation - où vous avez du code que vous voulez documenter mais n'avez pas non plus pris le temps ou ne vous souciez pas de le placer dans un paquet. Je suggère soit en lisant le README sur the github page for docstring ou voir la vignette fournie sur le cran page for docstring.
Voici un exemple de session en utilisant docstring:
library(docstring)
square <- function(x){
#' Square a number
#'
#' Calculates the square of the input
#'
#' @param x the input to be squared
return(x^2)
}
# This will display the documentation for square
# just like any other help file would be displayed
?square
Bien sûr, je suis d'accord. Vous pouvez continuer. – amarchin
Documenter le code correctement nécessite beaucoup plus d'efforts que la construction d'un paquet. Je ne comprends pas vraiment pourquoi quelqu'un ferait le premier mais pas le dernier. – Roland
@Roland Même si je suis d'accord sur le plan pratique, dans la pratique, certaines personnes ont des flux de travail différents. S'ils sont prêts à écrire de la documentation sans modifier leur flux de travail pour créer un package complet, cela me convient parfaitement. Je dirai aussi que même si je pense que la création de paquets est beaucoup plus facile qu'autrefois, c'est encore un obstacle formidable pour ceux qui ne l'ont pas fait auparavant. – Dason