Juste un commentaire

Programmation R défensive

Colin Gillespie

Jumping Rivers

Je ne sais pas pour vous...

  • Un code évident aujourd'hui
  • L'est souvent beaucoup moins dans quelques semaines
Programmation R défensive

Commentaires

  • Vous pouvez ajouter des commentaires à votre code R avec #
  • Écrire de bons commentaires, c'est plus difficile qu'on pense !
# Ceci est un commentaire
# Le commentaire ci-dessus n'est pas très utile
# Ou bien ?
Programmation R défensive

Conseil 1 : éviter les commentaires évidents

  • Ce qui est « évident » n'est pas toujours simple à trancher
    • Par exemple, les commentaires
       # Parcourir les ensembles de données
 for (dataset in datasets) {
  # Lire l'ensemble de données
  r <- read.csv(dataset)
 }
      semblent raisonnables
    • Mais sont peut-être un peu trop évidents
Programmation R défensive

Conseil 2 : éviter les commentaires que vous ne mettrez jamais à jour

L'exemple le plus courant : les en-têtes au début du fichier

# Dernière mise à jour : 1967-02-25
# Auteur : D Law
# Statut : No 1
  • Ce type de commentaire n'est presque jamais mis à jour
  • J'ai déjà vu # list of packages used: XXX, YYY
Programmation R défensive

Conseil 3 : être cohérent

  • Commencez toujours par un seul # ou un double ##
  • Commencez par une majuscule : respectez la grammaire
  • Prudence avec l'humour
    • Ce qui vous fait rire peut offenser d'autres personnes
  • Commentez le code qui « a l'air louche »
  • Utilisez # TODO ou # XXX pour signaler un problème futur
Programmation R défensive

Passons à la pratique !

Programmation R défensive

Preparing Video For Download...