Créer le squelette d’un package

TP

Auteur·rice·s
Affiliation

Ghislain Durif

Frédéric Santos

CNRS, Univ. Bordeaux, MCC – UMR 5199 PACEA

Dans cette section, nous allons utiliser des fonctions R permettant de débuter aisément la création d’un package, c’est-à-dire d’obtenir immédiatement un template structuré avec tous les dossiers et fichiers nécessaires, présentés précédemment.

Nous pouvons par exemple appeler {errormes} le package que nous allons créer, dédié à l’évaluation d’erreurs de mesures.

1 Créer le squelette de package et le projet Rstudio

La création d’un nouveau package peut ou bien se faire “à la souris” dans Rstudio via le menu File > New Project > R package, ou bien tout simplement via l’instruction suivante, exécutée dans la console R :

library(usethis)

## Débuter la création d'un package :
create_package(
    path = "~/path/to/your/package/errormes", # adapter ici !
    roxygen = TRUE,
    rstudio = TRUE,
    check_name = TRUE
)

Dans les deux cas, un projet Rstudio sera créé dans le dossier que vous aurez choisi, avec le squelette minimal nécessaire pour commencer à travailler immédiatement sur le contenu du package. Une nouvelle session Rstudio aura également été ouverte pour ce nouveau projet.

2 Initialiser l’utilisation de Git

Même si nous ne commencerons à utiliser réellement Git qu’un peu plus tard, déclarons tout de suite que ce package utilisera Git pour versionner finement l’avancée du travail.

Pour cela, deux solutions possibles :

  1. Ouvrir un terminal système, ou le Terminal intégré à Rstudio, et exécuter l’instruction :

    git init
  2. Dans la console R, exécuter l’instruction :

    use_git()

La seconde solution est néanmoins préférable ici : en plus d’initialiser correctement l’utilisation de Git dans le projet en cours, elle se charge automatiquement de remplir un fichier .gitignore spécifiant les fichiers qui ne sont pas censés être versionnés par Git (nous y reviendrons), et se charge également de faire une première capture (un commit) de l’état initial du projet.

Exercice. Inspectez les fichiers créés par les instructions create_package() et use_git() dans votre projet.

Retour au sommet