La programmation sous R est très accessible car interactive et peu contraignante, que ce soit dans le fond (typage dynamique) ou dans la forme (pas d'indentation obligatoire comme dans Python). Ceci amène à une qualité de code très hétérogène en fonction des utilisateurs, en particulier sous sa forme, ce qui impact beaucoup sur sa lisibilité.

Or un utilisateur de R passera plus de temps à relire son code qu'à l'écrire. De plus, il est courant de transmettre du code d'une personne à une autre dans une équipe. La lisibilité du code est donc cruciale. Dans cet article, je vais présenter une bibliographie touchant à ce problème de style de codage dans R. L'objectif plus général est de pouvoir écrire un "R Coding Style" adapté à l'activité de mon service.

Méthode

Plusieurs recherches ont été menées :

  • recherche dans le moteur de recherche "Google" avec les mots clefs "R coding style" en ne gardant que les réponses pertinente de la première page de résultats.
  • Suivi systématique des références proposées dans les documents trouvés.
  • Recherche de la documentation sur des règles de codage générales indépendament du language a été recherché à l'aide de "Coding style" dans Google et Wikipedia.
  • Recherche  en Français sur Google avec les mots clefs "Règles de Codage R". Une sélection de documents a été retenu et rapidement décrite afin d'être utiliser comme base de travail pour le développement de notre propre règle de codage.

Résultats

R, Bonnes pratiques Document

PDF en Français de 19 pages proposé sur le site du CRAN. A la fois didactique et pratique. Excellente base de travail.

R Style. An Rchaeological Commentary Document

PDF de 12 pages librement accessible sur le CRAN. Il donne des élements de réflexion et des élements pratiques. Bon point de départ en Anglais.

Google's R Style Guide

Page web. A la fois complet et concis.

Wikipedia

Permet d'avoir d'avoir des notions générale sur les règles de codage en Français et en Anglais.

PEP8

Le style de codage de Python.

R Coding Conventions

Document collaboratif sur Google Docs en cours de création. Permet d'avoir des choses très précises.

Autres

Conclusion

Il existe déjà une abondante documentation sur les règles de codage en R. Cependant, il n'existe pas de consensus sur l’ensemble des règles de codage et la complexité de certaines règles ne sont pas applicables dans le cadre de mon service. Une règle de codage pour R spécifique pour mon service devra donc être décrite.