Bonnes pratiques pour les projets statistiques

Une formation aux bonnes pratiques avec Git et R

Introduction

Version courte de la formation aux bonnes pratiques avec R et Git

Retour à la page d’accueil pour explorer les autres versions

Introduction

La notion de bonnes pratiques

Origine : communauté des développeurs logiciels

Constats :
- le “code est plus souvent lu qu’écrit” (Guido Van Rossum)
- la maintenance d’un code est très coûteuse

Conséquence : un ensemble de règles informelles, conventionnellement acceptées comme produisant des logiciels fiables, évolutifs et maintenables

Pourquoi s’intéresser aux bonnes pratiques ?

L’activité du statisticien / datascientist tend à se rapprocher de celle du développeur :

projets intenses en code

projets collaboratifs et de grande envergure

complexification des données et donc des infrastructures

déploiement d’applications pour valoriser les analyses

Bonnes pratiques et reproductibilité

Source : Peng R., Reproducible Research in Computational Science, Science (2011)

Une reproductibilité parfaite est coûteuse

Git est un standard atteignable et efficient

Note

Quel socle de bonnes pratiques pour les projets statistiques en ?

Horizon de cette formation

Un point de départ commun

Horizon de cette formation

Un point de départ commun

Une structuration de projet plus viable

Partie 1 : contrôle de version avec `Git`

Plan de la partie

1️⃣ Le contrôle de version : pourquoi faire ?

2️⃣ Le contrôle de version avec Git

I- Le contrôle de version : pourquoi faire ?

1️⃣ Archiver son code proprement

pour en finir avec ça :

1️⃣ Archiver son code proprement

ou ça :

1️⃣ Archiver son code proprement

ou encore ça :

prior <- read_csv(prior_path)
prior <- prior %>%
    select(id, proba_inter, proba_build, proba_rfl) %>%
    separate(id, into = c('nidt', 'grid_id'), sep = ":") %>%
    group_by(nidt) %>%
    mutate(
        proba_build = proba_build/sum(proba_build),
        proba_rfl = proba_rfl/sum(proba_rfl),
        ) %>%
    unite(col = "id", nidt, grid_id, sep = ":")

# Test
# prior_test <- prior %>%
#    mutate(
#        proba_inter = round(proba_inter, 4)
#        proba_build = round(proba_build, 4)
#        proba_rfl = round(proba_rfl, 4)
#    )

write_csv(prior_round, "~/prior.csv")

1️⃣ Archiver son code proprement

Pour arriver à ça :

Source : ThinkR

2️⃣ Voyager dans le temps (de votre projet)

3️⃣ Une collaboration simplifiée et efficace

Un modèle distribué

Source : specbee.com

3️⃣ Une collaboration simplifiée et efficace

Qui permet l’expérimentation en toute sécurité

Source : lutece.paris.fr

3️⃣ Une collaboration simplifiée et efficace

Quel que soit l’environnement de travail

3️⃣ Une collaboration simplifiée et efficace

Avec des outils pour faciliter la collaboration

4️⃣ Partager son code à un public large

Une vitrine pour les projets et l’organisation

En résumé

Construire et naviguer à travers l’historique de son projet

La collaboration rendue simple et efficace

Améliorer la reproductibilité de ses projets

Améliorer la visibilité de ses projets

II- Le contrôle de version avec `Git`

⚠️ Git est complexe

L’utilisation de Git nécessite certaines notions préalables:

Fonctionnement d’un filesystem
Connaissance basique du terminal Linux
Potentiellement, un grand nombre de commandes

⚠️ Git est complexe

Mais

L’usage quotidien n’implique que quelques commandes
Lors de chaque action, Git renvoie un message qui indique s’il y a eu problème (il faut lire les messages de Git!)
Enormément de ressources disponibles sur internet
Des interfaces visuelles (ex: RStudio, Sublime Merge, VS Code) qui facilitent l’apprentissage
Un petit investissement individuel pour de gros gains collectifs

Concepts

`Git`, `GitHub`, `GitLab`… quelles différences ?

Git est un logiciel ;
Utilisation en ligne de commandes
Différentes interfaces graphiques (RStudio, VS Code…)

Concepts

`Git`, `GitHub`, `GitLab`… quelles différences ?

GitHub et GitLab sont des forges logicielles
Forge: espace d’archivage de code
Des fonctionalités supplémentaires : réseau social du code

Astuce

GitHub : utilisation pour les projets open-source
GitLab : utilisation pour les projets internes

Concepts

Dépôt local / dépôt distant (`remote`)

Par défaut, le dépôt distant porte l’alias origin

Concepts

Workflow local

Source : Git Documentation

Concepts

Workflow complet

Commandes essentielles

Action	Commande
Cloner un projet	`git clone [url-to-git-repo]`
Afficher les changements	`git status`
Retrouver l’URL du dépôt distant	`git remote -v`

Commandes essentielles

Action	Commande
Ajouter des changements à l’index de `Git` (stage fixes)	Un seul fichier : `git add <file-name>` Tous les fichiers déjà indexés : `git add -u` Tous les fichiers ⚠️ : `git add -A`

Warning

La méthode git add -A peut amener à suivre les modifications de fichiers qui ne devraient pas l’être (par exemple, des données).

Il est recommandé de bien réfléchir avant de l’utiliser (ou d’avoir un bon .gitignore)

Commandes essentielles

Action	Commande
Faire un `commit`	`git commit -m "message"`
Pousser les changements locaux vers le dépôt distant (branche `master`)	`git push origin master`
Récupérer les changements sur le dépôt distant (branche `master`)	`git pull origin master`

Modes d’authentification

insee

https
- git clone https://github.com/username/projet.git
- simple à utiliser
- authentification username + password (ou token) à chaque push
ssh
- git clone git@github.com:username/projet.git
- (plus) complexe à initialiser
- authentification automatique

https
- git clone https://gitlab.insee.fr/username_or_groupname/projet.git
- simple à utiliser
- authentification username + password (ou token) à chaque push
ssh
- git clone git@gitlab.insee.fr:username_or_groupname/projet.git
- (plus) complexe à initialiser
- authentification automatique

Application 0

insee

Préparation de l’environnement de travail

Créer un compte GitHub
Créer un nouveau dépôt privé sur GitHub
Créer un compte sur le SSP Cloud
Lancer un service RStudio. Dans l’onglet de configuration Git du service, fixer la durée du Cache pour le stockage des identifiants GitHub à une valeur suffisamment élevée
Cloner le dépôt distant sur votre environnement local (ici, le RStudio du Datalab):
- File → New project → Version Control → Git
Générer un token (jeton d’authentification) sur GitHub
Stocker le token sur le SSP Cloud (ou un gestionnaire de mot de passe) :
- Mon Compte -> Git -> Token d'accès personnel pour Forge Git
Terminer la procédure de clonage en fournissant le nom d’utilisateur GitHub et le token

Préparation de l’environnement de travail

Compte déjà créé sur le gitlab interne
Créer un nouveau dépôt privé sur gitlab.insee.fr
Créer un compte sur LS3 via AUS.
Lancer un service RStudio. Dans l’onglet de configuration Git du service, fixer la durée du Cache pour le stockage des identifiants Gitlab à une valeur suffisamment élevée
Cloner le dépôt distant sur votre environnement local (ici, le RStudio de la plateforme LS3):
- File → New project → Version Control → Git
Générer un token (jeton d’authentification) sur gitlab.insee.fr
Stocker le token sur LS3 (ou un gestionnaire de mot de passe) :
- Mon Compte -> Git -> Token d'accès personnel pour Forge Git
Terminer la procédure de clonage en fournissant le nom d’utilisateur gitlab.insee.fr (code insee en 6 caractères) et le token

❓ Question : qu’est ce qui différencie le projet cloné d’un projet quelconque ?

Application 1

Premiers commits

Créer un dossier 📁 scripts
Y créer les fichiers script1.R et script2.R, chacun contenant quelques commandes R de votre choix
Ajouter ces fichiers à la zone de staging de Git en les cochant dans l’interface RStudio
Effectuer un commit, auquel on donnera un message descriptif pertinent
Supprimer le fichier script1.R et modifier le contenu du fichier script2.R
Analyser ce qui se passe lorsque l’on coche ces fichiers dans l’interface RStudio
Effectuer un nouveau commit pour ajouter ces modifications à l’historique
Visualiser l’historique du projet à partir de l’interface graphique de RStudio

❓ Question : à ce stade, le dépôt du projet sur GitHub / Gitlab (remote) a-t-il été modifié ?

Application 2

Interactions avec le dépôt distant

Effectuer un push pour intégrer les changements locaux au projet distant
Parcourir l’historique du projet sur GitHub / Gitlab
1. Faire apparaître les différences entre deux versions consécutives du projet
2. Afficher une version passée du projet

Bonnes pratiques

Que versionne-t-on ?

Essentiellement du code source
Pas d’outputs (fichiers .html, .pdf, modèles…)
Pas de données, d’informations locales ou sensibles

Note

Pour définir des règles qui évitent de committer tel ou tel fichier, on utilise un fichier nommé .gitignore.

Si on mélange du code et des éléments annexes (output, données…) dans un même dossier, il faut consacrer du temps à ce fichier.

Des modèles de .gitignore existent sur internet, par exemple celui-ci pour les projets .

N’hésitez pas à y ajouter des règles conservatrices (par exemple *.csv), comme cela est expliqué dans la documentation utilitR.

Bonnes pratiques

Format des commits

Fréquence
- Aussi souvent que possible
- Le lot de modifications doit “avoir du sens”
Messages
- Courts et informatifs (comme un titre de mail)
- Décrire le pourquoi plutôt que le comment dans le texte

Application 3

Le fichier .gitignore

Lors de la création du projet sur GitHub / Gitlab, nous avons demandé la création d’un fichier .gitignore, qui se situe à la racine du projet. Il spécifie l’ensemble des fichiers qui seront toujours exclus de l’indexation faite par Git.

Exclure les fichiers de type *.pdf et *.html
Créer un dossier data à la racine du projet et créer à l’intérieur de celui-ci un fichier data/raw.csv avec une ligne de données quelconque
Ajouter au .gitignore le dossier data/
Vérifier que toutes les règles ajoutées précédemment fonctionnent comme attendu

❓ Question : que se passe-t-il lorsque l’on ajoute au .gitignore des fichiers qui ont déjà été commit sur le projet Git ?

Ressources supplémentaires

Pour aller plus loin:
- Formation Travail collaboratif avec R
- La documentation utilitR propose plusieurs chapitres sur Git
- La Bible de l’usage de Git

Trouver de l’aide:
- Pour toute question : le salon Tchap Insee-Git-Gitlab
- A l’Insee : la documentation utilisateurs pour l’utilisation de Git sur AUS
- Sollicitez vos collègues utilisateurs de Git !

Partie 2 : bonnes pratiques avec `R`

Plan de la partie

Améliorations graduelles dans l’échelle de la reproductibilité :

1️⃣ Qualité du code

2️⃣ Structure des projets

3️⃣ Formats de données

Application 0

Préparation de l’environnement de travail

Si vous ne l’avez pas fait lors de la première partie de la formation, créer un compte sur GitHub et générer un token (jeton d’accès) d’authentification
Créer un nouveau dépôt public sur GitHub
Lancer un service RStudio. Dans l’onglet de configuration Git du service, fixer la durée du Cache pour le stockage des identifiants GitHub à une valeur suffisamment élevée
Cloner le dépôt distant sur votre environnement local (ici, le RStudio du Datalab):
- File → New project → Version Control → Git
Créer un script get_data.R en copiant le contenu de ce fichier, puis l’exécuter
Créer le script script.R dans votre dépôt en copiant le contenu de ce fichier
Ajouter la règle “individu_reg.*” au fichier .gitignore. Que signifie-t-elle ?
Commit/push les changements

I- Qualité du code

Enjeux

D’une vision utilitariste du code à une vision du code comme outil de communication

Favoriser la lisibilité et la maintenabilité

Faciliter la réutilisation

Assurer la transparence méthodologique

Principes généraux

Adopter les standards communautaires

Utiliser des fonctions

Documenter son code

Indiquer les packages utilisés afin d’éviter les conflits

1️⃣ Adopter les standards communautaires

“Good coding style is like correct punctuation: you can manage without it, butitsuremakesthingseasiertoread”

Tidyverse Style Guide

Respecter les conventions du langage dans lequel il est rédigé

Il existe un guide de référence pour bien coder en R : le Tidyverse style guide.

1️⃣ Adopter les standards communautaires

Deux outils pratiques aident à respecter les standards :

linter : programme qui vérifie que le code est formellement conforme à un certain guidestyle
- signale problèmes formels, sans corriger

formatter : programme qui reformate un code pour le rendre conforme à un certain guidestyle
- modifie directement le code

Astuce

Exemples d’erreurs repérées par un linter :
- lignes de code trop longues ou mal indentées, parenthèses non équilibrées, noms de fonctions mal construits…
Exemples d’erreurs non repérées par un linter :
- fonctions mal utilisées, arguments mal spécifiés, structure du code incohérente, code insuffisamment documenté…

1️⃣ Adopter les standards communautaires

Dans le cas de :

le linter à utiliser est le package lintr
le formatter à utiliser est le package styler.
- Existe également le package formatR.

2️⃣ Utiliser des fonctions

Règle d’or

Il faut utiliser une fonction dès qu’on utilise une même portion de code plus de deux fois (don’t repeat yourself (DRY))

Limite les risques d’erreurs liés aux copier/coller
Rend le code plus lisible et plus compact
Un seul endroit du code à modifier lorsqu’on souhaite modifier le traitement
Facilite la réutilisation et la documentation du code !

Règles pour écrire des fonctions pertinentes

Une tâche = une fonction
Une tâche complexe = un enchaînement de fonctions réalisant chacune une tâche simple
Limiter l’utilisation de variables globales.

3️⃣ Documenter son code

Grands principes :
- Documenter le pourquoi plutôt que le comment
- Privilégier l’auto-documentation via des nommages pertinents.

Comment bien documenter un script ?

Minimum 🚦 : commentaire au début du script pour décrire ce qu’il fait
Bien 👍 : commenter les parties “délicates” du code
Idéal 💪 : documenter ses fonctions avec la syntaxe roxygen2.

3️⃣ Documenter son code

Bien documenter… mais pas trop !

. . .

Bof :

# Utilise string si x est non manquant et non vide
if (!is.na(x) && nzchar(x)) {
  use_string(x)
}

. . .

Mieux !

x_is_not_empty_string <- (!is.na(x) && nzchar(x))
if (x_is_not_empty_string) {
  use_string(x)
}

. . . Voir la présentation de Maëlle Salmon sur le « Code beau ».

4️⃣ Pas d’ambiguïté sur les packages utilisés

Deux fonctions peuvent avoir le même nom dans des packages différents

R utilise par défaut la librairie chargée le plus récemment

Erreurs difficiles à repérer car il est nécessaire d’exécuter le code

Recommandation : indiquer explicitement le package : notation package::fonction()
- Exemple : dplyr::filter()

Exemple

package1 et package2 contiennent chacun une fonction appelée superFonction.
Si package2 est chargé après package1, alors superFonction désigne par défaut la fonction de package2.
Mieux vaut noter package1::superFonction et package2::superFonction

Ressources supplémentaires

Un cours complet sur la reproductibilité avec R
Une présentation très complète sur le partage de code et de données avec R
L’équivalent Python en 3A d’ENSAE

Application 1

Partie 1 : vérification du bon fonctionnement du code

Un code reproductible est avant toute chose un code fonctionnel ! Repérez les erreurs qui empêchent le script script.R de s’exécuter correctement, et les corriger.

Application 1

Partie 2 : premiers standards de qualité

Installer les packages R lintr et styler.
Définir le linter à utiliser comme étant de type tidyverse : lintr::use_lintr(type = "tidyverse")
Diagnostiquer le script script.R : lintr::lint("script.R").
- Comprenez-vous la nature des problèmes détectés par le linter?
Appliquer le formatter au script.R : styler::style_file("script.R").
Refaire tourner le linter. Il reste encore un certain nombre d’erreurs de formattage, car styler est un formatter peu intrusif.
Regarder les différents problèmes repérés par le linter, et en corriger quelques uns (un pour chaque type de problème).

Application 1

Partie 3 : une meilleure gestion des packages utilisés

Limiter les ambiguités sur les packages en utilisant la syntaxe package::fonction pour les packages rarement utilisés dans le script.
L’installation des packages dans un script n’est pas une bonne pratique. Supprimer les instructions correspondantes.
Importer le tidyverse au complet est rarement utile. N’importer à la place que les packages effectivement utilisés dans le script.

Application 1

Partie 4 : (auto-)documentation du code

Déplacer les library pour les mettre tous ensemble au début du script.
Le script n’est pas construit dans un ordre logique. Déplacer les parties pour adopter une structure plus logique :
- Gestion de l’environnement -> Définition de fonctions -> Import des données -> Retraitement des données -> Statistiques descriptives -> Graphiques -> Modélisation
Donner des titres aux parties/sous-parties en utilisant les standards de documentation reconnus par RStudio :
- # TITRE NIVEAU 1 ------------ et ## TITRE NIVEAU 2 ==========

Application 1

Partie 5 : une meilleure gestion des secrets

Repérer le jeton d’API dans le code. Retirer le jeton d’API du code et créer à la racine du projet un fichier YAML nommé secrets.yaml où vous écrivez ce secret sous la forme key: value. ⚠️ Attention : le package yaml impose la création d’une ligne vierge à la fin du fichier pour être valide.
Dans script.R, importer ce YAML (avec yaml::read_yaml("secrets.yaml")) pour créer une variable api_token ayant cette valeur.
Ajouter dans .gitignore le fichier secrets.yaml et indiquer dans le README.md de votre projet que les secrets sont stockés dans ce fichier. ⚠️ Attention : il ne faut pas committer secrets.yaml car le jeton d’API est personnel et secret!

Checkpoint

script.R

Bilan

Un code mal structuré
- Limite la lisibilité du projet
- Est très coûteux à maintenir (dette technique)

II- Structure des projets

Enjeux

Favoriser la lisibilité et la maintenabilité

2 Construire des projets reproductibles

⚠️ A ne pas reproduire chez vous

├── report.Rmd
├── correlation.png
├── data.csv
├── data2.csv
├── fig1.png
├── figure 2 (copy).png
├── report.pdf
├── partial data.csv
├── script.R
└── script_final.R

Source : eliocamp.github.io

Principes généraux

Utiliser les projets RStudio

Organiser son projet en sous-dossiers

Donner des noms pertinents aux fichiers

Documenter son projet

(Faire de son projet un package)

1️⃣ Utiliser les projets RStudio

Objectif : favoriser la reproductibilité
- Tous les fichiers nécessaires au projet dans un même dossier
- Le dossier contenant le projet RStudio est automatiquement utilisé comme working directory
- Utilisation de chemins relatifs plutôt qu’absolus.

Bonus : en utilisant Git, on s’assure de toujours travailler dans un projet RStudio !

2️⃣ Organiser son projet en sous-dossiers

Objectif : adopter une structure arbitraire, mais lisible et cohérente

├── data
│   ├── raw
│   │   ├── data.csv
│   │   └── data2.csv
│   └── derived
│       └── partial data.csv
├── R
|   ├── script.R
│   ├── script_final.R
│   └── report.Rmd
└── output
    ├── fig1.png
    ├── figure 2 (copy).png
    ├── figure10.png
    ├── correlation.png
    └── report.pdf

3️⃣ Donner des noms pertinents aux fichiers

Objectif : auto-documenter son projet

├── data
│   ├── raw
│   │   ├── dpe_logement_202103.csv
│   │   └── dpe_logement_202003.csv
│   └── derived
│       └── dpe_logement_merged_preprocessed.csv
├── R
|   ├── preprocessing.R
│   ├── generate_plots.R
│   └── report.Rmd
└── output
    ├── histogram_energy_diagnostic.png
    ├── barplot_consumption_pcs.png
    ├── correlation_matrix.png
    └── report.pdf

4️⃣ Documenter son projet

Le fichier README.md, situé à la racine du projet, est à la fois la carte d’identité et la vitrine du projet

Idéalement, il contient :
- Une présentation du contexte et des objectifs
- Une description de son fonctionnement
- Un guide de contribution (open-source)

Quelques modèles de README.md complets :
- utilitR
- DoReMIFaSol

5️⃣ Faire de son projet un package

Un package est la forme maximale de modularité
- Contient des fonctions rangées dans des modules
- Contient également de la documentation, des tests, des (méta-)données…
Avantages
- Idéal pour favoriser la réutilisation du code
- Des outils de développement : devtools et usethis
Inconvénients
- Coût de maintenance élevé

Ressources supplémentaires

La documentation utilitR sur les projets RStudio et les packages R
La bible des packages R
Un excellent workshop sur la reproductibilité avec R

Application 2

Partie 1 : modularisation du projet

Déplacer toutes les fonctions dans un fichier R/functions.R.
Donner à la fonction fonction_de_stat_agregee un nom plus pertinent et des noms d’arguments plus transparents.
Dans script.R, appeler en début de chaîne ces fonctions avec source("R/functions.R", encoding = "UTF-8").
Documenter la fonction principale au format attendu par roxygen2.
Ajouter les tests unitaires de la fonction comme exemples d’utilisation et les retirer de script.R.
Tester le bon fonctionnement de script.R.

Application 2

Partie 2 : création d’un package

Initialiser un package avec la fonction usethis::create_package()
Placer dans le dossier R du package un module stat.R et y copier la fonction de statistique agrégée
Charger le package avec la fonction devtools::load_all() et vérifier que la fonction marche correctement
Remplir le fichier DESCRIPTION. En particulier, spécifier les dépendances nécessaires (Imports) et facultatives (Suggests)
Construire la documentation du package avec la fonction devtools::document(). Où est-elle stockée et sous quel format ?
Vérifier que la documentation de notre fonction est accessible avec ?ma_fonction
(Facultatif) Initialiser un nouveau projet sur GitHub est y mettre le code du package. Vérifier que le package peut être installé en local avec la fonction devtools::install_github().

Checkpoint

III- Formats de données

Enjeux

Le choix d’un format de données répond à un arbitrage entre plusieurs critères :
- Finalité (traitement, analyse, diffusion)
- Public cible
- Volumétrie

Recommandations

Eviter impérativement les formats de données adhérents à un langage (RDS, RData, fst, sas7bdat, etc.).

Deux formats à privilégier :
- CSV : pour la plupart des usages courants
  - Avantage : non-compressé donc facilement lisible
  - Inconvénients : pas de gestion des méta-données, peu adapté aux données volumineuses
- Parquet : pour le traitement de données volumineuses
  - Compressé et très performant en lecture/écriture
  - Gestion native des méta-données

Application 3

Manipulation des formats CSV et Parquet

Effacer la base individu_reg.csv
Modifier le script get_data.R pour écrire les données au format Parquet à l’aide de la fonction arrow::write_parquet
Modifier la phase d’import dans script.R pour importer le fichier Parquet à l’aide de la fonction arrow::read_parquet

Checkpoint

Ressources supplémentaires

Pour aller plus loin:
- La documentation utilitR
- Un cours complet sur la reproductibilité avec R
- Cours Reproductibilité et bonnes pratiques pour les projets de data science de l’ENSAE

Trouver de l’aide:
- Pour toute question : le salon Slack grrr, très dynamique
- Le salon Tchap Langage R
- Pour l’utilisation de R à l’Insee : le salon Tchap Insee - Outils Stats v2

Conclusion

Les bonnes pratiques favorisent la reproductibilité et la réutilisation des projets statistiques

Des outils permettent d’appliquer les bonnes pratiques

Le coût est d’autant plus faible que l’on se place en amont du projet

Bonnes pratiques pour les projets statistiques

Introduction

Introduction

La notion de bonnes pratiques

Pourquoi s’intéresser aux bonnes pratiques ?

Bonnes pratiques et reproductibilité

Horizon de cette formation

Horizon de cette formation

Partie 1 : contrôle de version avec Git

Plan de la partie

I- Le contrôle de version : pourquoi faire ?

1️⃣ Archiver son code proprement

1️⃣ Archiver son code proprement

1️⃣ Archiver son code proprement

1️⃣ Archiver son code proprement

2️⃣ Voyager dans le temps (de votre projet)

3️⃣ Une collaboration simplifiée et efficace

3️⃣ Une collaboration simplifiée et efficace

3️⃣ Une collaboration simplifiée et efficace

3️⃣ Une collaboration simplifiée et efficace

4️⃣ Partager son code à un public large

En résumé

II- Le contrôle de version avec Git

⚠️ Git est complexe

⚠️ Git est complexe

Concepts

Git, GitHub, GitLab… quelles différences ?

Concepts

Git, GitHub, GitLab… quelles différences ?

Concepts

Dépôt local / dépôt distant (remote)

Concepts

Workflow local

Concepts

Workflow complet

Commandes essentielles

Commandes essentielles

Commandes essentielles

Modes d’authentification

Application 0

Application 1

Application 2

Bonnes pratiques

Bonnes pratiques

Application 3

Ressources supplémentaires

Partie 2 : bonnes pratiques avec R

Plan de la partie

Application 0

I- Qualité du code

Enjeux

Principes généraux

1️⃣ Adopter les standards communautaires

1️⃣ Adopter les standards communautaires

1️⃣ Adopter les standards communautaires

2️⃣ Utiliser des fonctions

3️⃣ Documenter son code

3️⃣ Documenter son code

4️⃣ Pas d’ambiguïté sur les packages utilisés

Ressources supplémentaires

Application 1

Application 1

Application 1

Application 1

Application 1

Checkpoint

Bilan

II- Structure des projets

Enjeux

⚠️ A ne pas reproduire chez vous

Principes généraux

1️⃣ Utiliser les projets RStudio

2️⃣ Organiser son projet en sous-dossiers

3️⃣ Donner des noms pertinents aux fichiers

4️⃣ Documenter son projet

5️⃣ Faire de son projet un package

Ressources supplémentaires

Application 2

Application 2

Checkpoint

Partie 1 : contrôle de version avec `Git`

II- Le contrôle de version avec `Git`

`Git`, `GitHub`, `GitLab`… quelles différences ?

`Git`, `GitHub`, `GitLab`… quelles différences ?

Dépôt local / dépôt distant (`remote`)

Partie 2 : bonnes pratiques avec `R`