depuis Galillé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 and Karrenbach 1992.
*érudition
Les concepts
Wilson et al. 2016. Plos Comp Biol. https://arxiv.org/pdf/1609.00037.pdf
Project Organization : Organisation des fichiers
Data management : Gestion des données
Software : Structure du code & Cohérence du flux d’analyses
Tracking Changes : Gestion des versions de fichiers
Collaboration
Manuscripts
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
![]()
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
- Peut 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
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) (… il faut être un geek)
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 de notre 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
- documentation de l’archive de recherche (README, license, code de contribution)
- plateforme de collaboration en ligne (intègre Git !) : github, gitlab
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
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)
![]()
Programme
| Monday |
- Research compendium & Good practices
- Version control with
Git & GitHub
|
| Tuesday |
- Literate programming:
R Markdown & Quarto
- Pipeline toolkit with
targets
|
| Wednesday |
- Dealing with R package versions with
renv
- Containerization with
Docker
- Building an R package
|
| Thursday |
|
| Friday |
|
