Depuis Galilée, le concept a un peu évolué…
Un article publié n’est que le sommet de l’iceberg que représente le processus de recherche…
“An article about computational results is advertising, not scholarship. The actual scholarship* is the full software environment, code and data, that produced the result.”
Claerbout & Karrenbach (1992) 10.1190/1.1822162
*érudition
Project organization
“Organizing the digital artifacts of a project to ease discovery and understanding”
Organiser tous les fichiers relatifs à un projet selon une structure cohérente (et standardisée)
Project organization
Research compendium
Data management
“Saving both raw and intermediate forms; Documenting all steps; Creating tidy data amenable to analysis”
Data management
Sauvegarder les données initiales en l’état
Coder l’acquisition des données au maximum (API, fonction download.file() de R)
Toute transformation des données sera codée, cela devient un résultat
Générer des données “bien rangées”, telles que vous voudriez les recevoir (tidy)
Tidy data
![]()
Software
“Writing, organizing, and sharing scripts and programs used in an analysis”
Software
Le code, les scripts
Respecter au maximum les conventions de code de votre communauté, https://style.tidyverse.org/
Peu importe la convention adoptée, rester constant !
Chemins relatifs ! Toujours !
Pas d’espaces, d’accents ni de MAJUSCULES !
Commenter/documenter (les fonctions, les scripts)
Software
![]()
Software
L’environnement logiciel
Les packages (versions !), la version de R (e.g. stringAsFactors = FALSE depuis 4.0, |> depuis 4.1) : utiliser le package renv
Et les bibliothèques système, la version de l’OS ?
Docker (Rocker pour R), permet de créer une image de l’environnement de travail (OS, bibliothèques système, R, packages) (c’est faisable !)
Software
Le “workflow” (enchaînement des scripts, des logiciels)
![]()
Software
Le “workflow” (enchaînement des scripts, des logiciels)
![]()
Il existe des outils pour ça (script R, package targets)
Tracking Changes
Archiver l’évolution de divers composants du projet
Tracking Changes
Utiliser un logiciel de gestion de versions (Git).
![]()
Collaboration
Faciliter la compréhension des projets de recherche : permettre la contribution, la vérification, la synthèse et la progression.
Collaboration
Conventions de code
Documentation de l’archive de recherche (README, license, code de contribution)
Plateforme de collaboration en ligne (intègre Git !) : GitHub, GitLab, Codeberg
Manuscripts
Writing manuscripts in a way that leaves an audit trail and minimizes manual merging of conflict
Manuscripts
Utiliser la programmation lettrée (literate programming)
“Au lieu de considérer que notre tâche principale est de dire à un ordinateur ce qu’il doit faire, appliquons-nous plutôt à expliquer à des êtres humains ce que nous voulons que l’ordinateur fasse”
Donald Knuth, années 70
Manuscripts
Utiliser la programmation lettrée (literate programming)
“Au lieu de passer des nuits entières à reformater des titres, insérer et renuméroter des figures et des tableaux, on ferait mieux de se concentrer sur la pertinence de son intro ou de sa discussion”
Manuscripts
En markdown, le texte est formaté en utilisant des balises très simples comme les _ ou les *
![]()
Manuscripts
Comment ça marche Quarto ?
![]()
Manuscripts
Formats d’export de Quarto (pandoc)
![]()
Program
| Monday |
- Project organization & Good practices
- Version control w/ Git (Part I)
|
| Tuesday |
- Version control w/ Git (Part II)
- Collaboration & sharing w/ GitHub
|
| Wednesday |
- Literate programming w/ Quarto
- Pipeline optimization w/ targets
- Developing an R package
|
| Thursday |
- Freezing package versions w/ renv
- Containerization w/ Docker
- Subgroups projects
|
| Friday |
|
