Générer un squelette de vignette R

Vous avez travaillé en étroite collaboration avec votre équipe sur le développement du package R unitConverter. Vous avez ajouté des données, créé des fonctions, documenté ces fonctions, et mis en place bien d’autres pratiques conformes à un développement de package réussi. Il est maintenant temps de générer une vignette pour ce package.

Le package usethis a été chargé pour vous.

Cet exercice fait partie du cours

<cours>Développer des packages R</cours>

Instructions de l’exercice

Créez une vignette avec le nom "dist_conversion" et le titre "Distance Conversion Examples".

Exercice interactif pratique

Essayez cet exercice en complétant ce code d’exemple.

# Create vignette
___

Modifier et exécuter le code

Cet exercice fait partie du cours

<cours>Développer des packages R</cours>

IntermédiaireNiveau de compétence

4.8+

Commencer le cours gratuitement

Explorez l’essentiel de la construction d’un package R : l’architecture, les dossiers clés R et man, ainsi que l’importance des fichiers DESCRIPTION et NAMESPACE. Mettez la main à la pâte avec le package usethis pour créer l’ossature de votre propre package et y inclure des données. Renforcez vos compétences d’écriture de fonctions R, intégrez les bonnes pratiques de développement de package et prenez l’habitude d’enregistrer des fonctions dans un fichier. Enfin, installez votre package en local avec devtools.

Exercise 1: Composants d’un package R Exercise 2: Vérités sur les packages R Exercise 3: Quels éléments sont nécessaires dans tous les packages R ?Exercise 4: Composants requis d’un package Exercise 5: Données et modèle R Markdown dans un package R Exercise 6: Créer un package R Exercise 7: Ajouter des données au package R Exercise 8: Créer un fichier modèle R Markdown pour un package R Exercise 9: Structure d’un fichier modèle R Markdown Exercise 10: Créer des fonctions de package Exercise 11: Fonction R pour convertir des distances Exercise 12: Installez le package R et testez-le

Découvrez les avantages de créer des packages plutôt que d’utiliser des scripts, et l’impact sur l’organisation du code, la reproductibilité, la collaboration et le partage. Apprenez des stratégies efficaces pour structurer le code et les fonctions dans le dossier R, et choisir un nom et une licence adaptés pour votre package. Enfin, vous verrez comment gérer les dépendances de packages CRAN.

Exercise 1: Structure avancée du package Exercise 2: Comparer packages et scripts Exercise 3: Vérifier le nom de votre package Exercise 4: Choisir une licence adaptée pour votre package Exercise 5: Construction du package Exercise 6: Ajout et test d’une nouvelle fonction dans le package Exercise 7: Déboguer les erreurs avec load_all()Exercise 8: Différences entre les erreurs, avertissements et notes de check()Exercise 9: Dépendances du package Exercise 10: Types de dépendances de packages R Exercise 11: Définir les dépendances du package Exercise 12: Définir davantage de dépendances de package

Exploitez la force des exemples dans la documentation en créant des exemples de fonctions avec roxygen2. Comprenez l’importance des exemples pour clarifier le comportement des fonctions et identifiez les éléments clés d’une fonction R bien documentée. Explorez le rôle des vignettes dans la documentation d’un package R et apprenez les bonnes pratiques pour créer des vignettes attrayantes, puis évaluer leur contenu et leur qualité grâce à l’analyse des métadonnées.

Exercise 1: Fichiers d’aide avec les packages R Exercise 2: Ordre des composants d’un fichier d’aide Exercise 3: Fonctions exportées et non exportées Exercise 4: Documentation avec roxygen2 Exercise 5: Premiers éléments de documentation de fonction Exercise 6: Documentation des arguments de fonction Exercise 7: Valeurs de retour et export d’une fonction Exercise 8: Générer la documentation des fichiers d’aide Exercise 9: Premiers pas avec les vignettes de packages R Exercise 10: Parcourir les vignettes d’un package Exercise 11: Propriétés des vignettes et des articles Exercise 12: Concevoir des vignettes de package R Exercise 13: Générer un squelette de vignette R

Exercice actuel

Exercise 14: Concevoir une vignette de package R Exercise 15: Générer des vignettes de package

Identifiez pourquoi les tests unitaires sont importants pour le développement et la maintenance d’un package et apprenez à utiliser le package testthat pour les réaliser. Convertissez des exemples R en attentes afin d’étoffer vos connaissances en tests unitaires. Vous comprendrez ensuite comment documenter les données de votre package et lancer des vérifications finales pour vous assurer que vous avez développé un package R robuste.

Exercise 1: Tests unitaires Exercise 2: Avantages des tests unitaires Exercise 3: Configurer votre package pour les tests Exercise 4: Créer un fichier de tests Exercise 5: Explorer les instructions expect Exercise 6: Transformer un exemple en test Exercise 7: Vérifier les avertissements et les erreurs Exercise 8: Vérifier la sortie et l’identité Exercise 9: Enregistrer les attentes comme tests unitaires et exécuter les tests Exercise 10: Corriger des erreurs d’expectation Exercise 11: Lancer un test sur les exemples de la fonction Exercise 12: Exécuter tous les tests du package Exercise 13: Dernières étapes Exercise 14: Finalisez votre fichier DESCRIPTION Exercise 15: Documenter vos données Exercise 16: Vérifiez votre package R Exercise 17: Félicitations !