{"id":5362,"date":"2025-01-15T11:20:02","date_gmt":"2025-01-15T10:20:02","guid":{"rendered":"https:\/\/thinkr.fr\/abcdr\/utiliser_roxygen2_pour_documenter_un_package\/"},"modified":"2025-01-15T11:20:02","modified_gmt":"2025-01-15T10:20:02","slug":"utiliser_roxygen2_pour_documenter_un_package","status":"publish","type":"post","link":"https:\/\/thinkr.fr\/abcdr\/utiliser_roxygen2_pour_documenter_un_package\/","title":{"rendered":"Utiliser roxygen2 pour documenter un package"},"content":{"rendered":"<h1>Utiliser roxygen2 pour documenter un package R<\/h1>\n<p>La documentation est un aspect essentiel du d\u00e9veloppement de packages en R. Une bonne documentation aide les utilisateurs \u00e0 comprendre comment utiliser votre package et ses fonctions. <code>roxygen2<\/code> est un outil populaire qui facilite la cr\u00e9ation de documentation en utilisant des commentaires dans le code. Dans cet article, nous allons voir comment utiliser <code>roxygen2<\/code> pour documenter un package R de mani\u00e8re simple et efficace.<\/p>\n<h2>Installation de roxygen2<\/h2>\n<p>Avant de commencer, assurez-vous d&rsquo;avoir install\u00e9 le package <code>roxygen2<\/code>. Vous pouvez l&rsquo;installer depuis CRAN avec la commande suivante :<\/p>\n<pre><code>install.packages(\"roxygen2\")<\/code><\/pre>\n<h2>Structure d&rsquo;un package R<\/h2>\n<p>Un package R doit avoir une structure sp\u00e9cifique. Voici les \u00e9l\u00e9ments de base :<\/p>\n<ul>\n<li>Un dossier principal avec le nom de votre package.<\/li>\n<li>Un sous-dossier <code>R\/<\/code> pour les fichiers de code R.<\/li>\n<li>Un fichier <code>DESCRIPTION<\/code> pour d\u00e9crire le package.<\/li>\n<li>Un fichier <code>NAMESPACE<\/code> pour g\u00e9rer l&rsquo;exportation des fonctions.<\/li>\n<\/ul>\n<h2>Exemple de documentation avec roxygen2<\/h2>\n<p>Imaginons que nous avons une fonction simple qui additionne deux nombres. Nous allons cr\u00e9er un package appel\u00e9 <code>monPackage<\/code> et documenter cette fonction.<\/p>\n<h3>\u00c9tape 1 : Cr\u00e9er la fonction<\/h3>\n<p>Dans le dossier <code>R\/<\/code>, cr\u00e9ons un fichier appel\u00e9 <code>addition.R<\/code> et ajoutons la fonction suivante :<\/p>\n<pre><code class=\"language-R\"># addition.R\n\naddition &lt;- function(a, b) {\n  return(a + b)\n}<\/code><\/pre>\n<h3>\u00c9tape 2 : Documenter la fonction avec roxygen2<\/h3>\n<p>Pour documenter la fonction, nous allons ajouter des commentaires <code>roxygen2<\/code> juste au-dessus de la d\u00e9finition de la fonction. Voici comment faire :<\/p>\n<pre><code class=\"language-R\">#' Additionne deux nombres\n#'\n#' Cette fonction prend deux nombres en entr\u00e9e et retourne leur somme.\n#'\n#' @param a Un nombre.\n#' @param b Un nombre.\n#' @return La somme de a et b.\n#' @examples\n#' addition(2, 3) # retourne 5\n#' addition(-1, 1) # retourne 0\n#' @export\naddition &lt;- function(a, b) {\n  return(a + b)\n}<\/code><\/pre>\n<h3>Explication des tags roxygen2<\/h3>\n<ul>\n<li><code>#'<\/code> : Indique que le texte suivant est un commentaire de documentation.<\/li>\n<li><code>@param<\/code> : D\u00e9crit un param\u00e8tre de la fonction.<\/li>\n<li><code>@return<\/code> : Indique ce que la fonction retourne.<\/li>\n<li><code>@examples<\/code> : Fournit des exemples d&rsquo;utilisation de la fonction.<\/li>\n<li><code>@export<\/code> : Indique que la fonction doit \u00eatre export\u00e9e pour \u00eatre accessible aux utilisateurs du package.<\/li>\n<\/ul>\n<h3>\u00c9tape 3 : G\u00e9n\u00e9rer la documentation<\/h3>\n<p>Apr\u00e8s avoir ajout\u00e9 la documentation, vous devez g\u00e9n\u00e9rer les fichiers de documentation. Dans le r\u00e9pertoire principal de votre package, ex\u00e9cutez la commande suivante :<\/p>\n<pre><code class=\"language-R\">library(roxygen2)\nroxygen2::roxygenise()<\/code><\/pre>\n<p>Cette commande va cr\u00e9er ou mettre \u00e0 jour le fichier <code>NAMESPACE<\/code> et g\u00e9n\u00e9rer la documentation en format Rd dans le dossier <code>man\/<\/code>.<\/p>\n<h3>\u00c9tape 4 : V\u00e9rifier la documentation<\/h3>\n<p>Pour v\u00e9rifier que la documentation a \u00e9t\u00e9 correctement g\u00e9n\u00e9r\u00e9e, vous pouvez utiliser la fonction <code>?<\/code> suivie du nom de votre fonction dans la console R :<\/p>\n<pre><code>?addition<\/code><\/pre>\n<p>Cela ouvrira la documentation de la fonction <code>addition<\/code>, o\u00f9 vous pourrez voir la description, les param\u00e8tres, le retour et les exemples.<\/p>\n<h2>Conclusion<\/h2>\n<p>Utiliser <code>roxygen2<\/code> pour documenter un package R est un moyen efficace et simple de s&rsquo;assurer que votre code est bien document\u00e9. En ajoutant des commentaires clairs et en utilisant les tags appropri\u00e9s, vous pouvez cr\u00e9er une documentation utile pour vous et pour les utilisateurs de votre package. N&rsquo;h\u00e9sitez pas<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Utiliser roxygen2 pour documenter un package R La documentation est un aspect essentiel du d\u00e9veloppement de packages en R. Une bonne documentation aide les utilisateurs \u00e0 comprendre comment utiliser votre package et ses fonctions. roxygen2 est un outil populaire qui facilite la cr\u00e9ation de documentation en utilisant des commentaires dans le code. Dans cet article, nous allons voir comment utiliser roxygen2 pour documenter un package R de mani\u00e8re simple et efficace. Installation de roxygen2 Avant de commencer, assurez-vous d&rsquo;avoir install\u00e9 le package roxygen2. Vous pouvez l&rsquo;installer depuis CRAN avec la commande suivante : install.packages(\u00ab\u00a0roxygen2\u00a0\u00bb) Structure d&rsquo;un package R Un package R doit avoir une structure<a class=\"more-link\" href=\"https:\/\/thinkr.fr\/abcdr\/utiliser_roxygen2_pour_documenter_un_package\/\">Read More &rarr;<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"content-type":"","rop_custom_images_group":[],"rop_custom_messages_group":[],"rop_publish_now":"initial","rop_publish_now_accounts":{"twitter_399453572_399453572":""},"rop_publish_now_history":[],"rop_publish_now_status":"pending","jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[227],"tags":[229,228],"class_list":{"0":"entry","1":"post","2":"publish","3":"author-vincent","4":"post-5362","6":"format-standard","7":"category-documentation","8":"post_tag-documentation","9":"post_tag-roxygen2"},"acf":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p9O7Sx-1ou","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/thinkr.fr\/abcdr\/wp-json\/wp\/v2\/posts\/5362","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/thinkr.fr\/abcdr\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/thinkr.fr\/abcdr\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/thinkr.fr\/abcdr\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/thinkr.fr\/abcdr\/wp-json\/wp\/v2\/comments?post=5362"}],"version-history":[{"count":0,"href":"https:\/\/thinkr.fr\/abcdr\/wp-json\/wp\/v2\/posts\/5362\/revisions"}],"wp:attachment":[{"href":"https:\/\/thinkr.fr\/abcdr\/wp-json\/wp\/v2\/media?parent=5362"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/thinkr.fr\/abcdr\/wp-json\/wp\/v2\/categories?post=5362"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/thinkr.fr\/abcdr\/wp-json\/wp\/v2\/tags?post=5362"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}