Package
Objectif
Dans cet exercice, vous allez créer un package .
Consignes
Créez un nouveau projet RStudio.
- Utilisez la fonction
rcompendium::add_description()
pour ajouter un fichier DESCRIPTION - Utilisez la fonction
rcompendium::add_to_gitignore()
pour ajouter un .gitignore spécifique à - Implémentez des fonctions dans le dossier R/ et documentez-les avec la syntaxe roxygen2. Vous pouvez réutiliser certaines fonctions développées lors des exercices précédents.
- Mettez à jour la documentation des fonctions avec
devtools::document()
- Mettez à jour les dépendances dans le fichier DESCRIPTION avec
rcompendium::add_dependencies()
- Vérifiez que votre package ne comporte pas d’erreur avec
devtools::check()
- Ajoutez un README.Rmd avec
rcompendium::add_readme_rmd()
et éditez-le. N’oubliez pas de le transpiler en README.md avecrmarkdown::render()
- Utilisez la fonction
usethis::use_github()
pour envoyer votre projet sur GitHub.
Pensez aux commits !
Bonus
Mettez en place des GitHub Actions pour :
- Vérifiez votre package sur les serveurs GitHub après chaque push avec
rcompendium::add_github_actions_check()
- Déployez le site Web du package avec
rcompendium::add_github_actions_pkgdown()
Ajoutez au README.Rmd les badges correspondants avec rcompendium::add_github_actions_check_badge()
et rcompendium::add_github_actions_pkgdown_badge()
.
La fonction
new_package()
L’ensemble de ces étapes peut être réalisé avec une seule fonction : new_package()
de rcompendium
.
N’oubliez pas de créer un nouveau projet RStudio avant si vous voulez l’utiliser.