Rzine
Articles méthodologiques notebook, pour les sciences humaines et sociales
Séminaire de Méthodologie (MetSem) - RésIn, SciencePo Paris
Ingénieur d’études en sciences de l’info. géographique
CNRS - UMR Géographie-Cités (FR CIST jusqu’en 2022)
L’utilisation d’un langage de programmation m’a conduit à de nouvelles pratique, méthodes, organisation de travail, outils…
La programmation lettrée est une approche de la programmation qui se veut différente du paradigme de programmation structurée.
« Nous devons changer notre attitude traditionnelle envers la construction des programmes : 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. (…)
Celui qui pratique la programmation lettrée peut être vu comme un essayiste, qui s’attache principalement à exposer son sujet dans un style visant à l’excellence. Tel un auteur, il choisit, avec soin, le dictionnaire à la main, les noms de ses variables et en explique la signification pour chacune d’elles. Il cherche donc à obtenir un programme compréhensible parce que ses concepts sont présentés dans le meilleur ordre possible. Pour cela, il utilise un mélange de méthodes formelles et informelles qui se complètent. »
Le paradigme de la programmation lettrée, pensé et mis en oeuvre par Donald Knuth (1977-78), s’éloigne dans son écriture de l’ordonnancement imposé par l’ordinateur, et à la place autorise les développeurs à utiliser un ordre imposé par la logique et le fil de leur pensée.
Quelques lignes de code…
library(ggplot2)
ggplot(data = iris,
aes(x = cut(Sepal.Length, breaks = c(min(Sepal.Length), 5, 6, 7, max(Sepal.Length)),
include.lowest = TRUE, labels = c("Bas","Bas+","Haut","Haut+")))) +
geom_bar() + xlab("") + ylab("") + ggtitle("Répartition par classe") +
theme(plot.title = element_text(size=27), axis.text=element_text(size=19))
…En programmation lettrée
#----------------------------------------------------------------------
# Représentation graphique de la répartition d'individus
# discrétisés en quatre classes
#
# H. Pecout
# 20 juin 2024
#----------------------------------------------------------------------
#------------ Discrétisation la variable Sepal.Length -----------------
## Statistiques sur la série statistique 'Sepal.Length'
summary(iris$Sepal.Length)
## Histogramme de la distribution
hist(iris$Sepal.Length)
## Choix des bornes de classes (amplitude égale)
bornes_des_classes <- c(min(iris$Sepal.Length), 5, 6, 7,
max(iris$Sepal.Length))
## Choix des noms de classes
nom_des_classes <- c("Trés petites","petites","grandes","Très grandes")
## Discrétisation de la variable 'Sepal.length'
iris$classe <- cut(iris$Sepal.Length,
breaks = bornes_des_classes,
labels = nom_des_classes,
include.lowest = TRUE)
#---------- Représentation graphique de la distribution --------------
## Library pour la représentation graphique
library(ggplot2)
## Représentation graphique de la distribution
ggplot(data = iris, aes(x = classe)) + # Choix des données et de la variable à représenter
geom_bar() + # Choix du type de représentation
xlab("") + # Suppression du nom de l'axe x
ylab("") + # Suppression du nom de l'axe y
ggtitle("Répartition par classe") + # Titre du graphique
theme(plot.title = element_text(size=27), # Taille de la police titre
axis.text=element_text(size=19)) # Taille des labels d'axeIl est possible de faire de la programmation lettrée dans n’importe quel type de document…
Le document computationnel est l’environnement parfait pour mettre en oeuvre ce paradigme.
Un document computationnel permet de combiner du langage naturel et du langage de programmation :
La programmation lettrée et les documents computationnels sont apparus à la même période, celle de l’émergence du concept de recherche reproductible !
Définition : interface de programmation qui permet de combiner des sections en langage naturel et des sections en langage informatique.
En raison de l’évolution et de la diversité des outils logiciels disponibles dans ce domaine, il existe de nombreuses dénominations pour les documents computationnels .
Cela reflète la diversité de leurs caractèristiques, de leurs fonctionnalités, des approches différentes de conception et d’utilisation.
C’est la raison pour laquelle, les noms propres des différents dispositifs son souvent utilisés (ex : carnet Jupyter, Observable, Rmarkdown, Quarto…)
Un fichier texte (.rmd, .qmd, .ipynb…)
La mise en forme du texte se fait à l’aide d’un langage de balisage (Markdown, html…)
Une forge logicielle est un système de gestion de rédaction, de partage et de maintenance collaborative de (fichier) texte. Bien que son usage premier soit pour le développement de logiciels, une forge peut aussi être utilisée pour la rédaction de documentation, de rapports ou présentation (LaTeX, Markdown, Notebook…), ainsi que pour la réalisation de sites web.
Les forges logicielles, comme GitHub ou GitLab, sont parfaites pour :
➡️ Versioner les codes sources de notebook
➡️ Archiver et partager le code source des notebook
➡️ Compiler un notebook - Continuous Integration
➡️ Déployer un notebook compilé en HTML - Continuous Deployment
Un exemple ?
Chunk de code R (exécuté et affiché)
##------------------------ PACKAGES utilisés --------------------------##
# install.packages("sf")
# install.packages("leaflet")
# Chargement des librairies
library(sf)
library(leaflet)
##----------------- Création d'un objet sf (point) --------------------##
# Cordonnées de Sciences Po - Campus 1, Saint-Thomas
lat = 48.856172645935274
lng = 2.328557196883221
# Création d'un point
ptsfg <- st_point(c(lng, lat))
# Ajout du système géographique de référence
ptsfc <- st_sfc(ptsfg, crs = (4326))
# Création de l'attribut "name"
ptdf <- data.frame(id= 1, name = "Sciences Po - Campus 1, Saint-Thomas")
# Création de l'objet sf ponctuel
Here <- st_sf(ptdf,geometry = ptsfc)
##--------------------- Création carte dynamique ----------------------##
# Lien vers une photo du campus
file <- 'https://paris-promeneurs.com/wp-content/uploads/2022/07/hotel-artillerie4-800.jpg'
# Construction du marker
icons <- awesomeIcons(icon = 'ios-people',
iconColor = 'white',
library = 'ion',
markerColor = 'blue')
# Affichage du point - carte interactive
mamap <- leaflet(Here) %>%
setView( lat = lat, lng = lng, zoom = 13) %>%
addProviderTiles("GeoportailFrance.orthos") %>%
addAwesomeMarkers(icon = icons,
popup = paste("<img src =", file, ">",
"<p style='text-align:center;'>Sciences Po</br>Campus Saint-Thomas</a></p>"))Affichage du résultat :
Objectif annoncé
Produire de la documentation sur la pratique de R en SHS et contribuer à une montée en compétence collective
Source : https://arshs.hypotheses.org/403
Bilan
Communauté active, beaucoup de ressources, langage commun à plusieurs disciplines, de très bonnes initiatives francophones… et le document computationnel comme principal format des ressources disponibles.
I. Mise en avant de l’existant : Rzine.fr
II. Favoriser le partage de méthodes reproductibles
Différents statuts & profils, mais encore trop de géographes !
+ de 10 membres mais aucun avec du temps de travail officiellement alloué au projet
L’ouverture de la science ne se limite pas aux données et aux articles
Et surtout…
:
le comité éditorial s’engage à accompagner les auteur·es (et relecteur·rices) dans le processus de publication, voire à les former (rmarkdown, GitHub)
L’utilisation des notebooks n’est pas indispensable pour un article comportant du code.
L’usage simple du markdown pourrait aussi être une solution, ex : Programming Historian
L’utilisation du notebook (code executé à la compilation du document) permet de :
La transposition d’un bout de code dans un format d’article est plus simple et efficace avec un notebook, car il n’est pas nécessaire de basculer d’un outil (Langage de programmation) à un autre (logiciel de traitement de texte).
Document qui présente une méthodologie, un type d’analyse, une fonctionnalité, ou encore le traitement d’un certain type de données réalisé avec R, de façon reproductible et didactique (literate programming) afin d’en faciliter son application pratique.
Un article peut être fortement axé sur un aspect technique ou méthodologique, mais elle doit impérativement s’ancrer dans une thématique des sciences humaines, sociales ou territoriales.
Un article doit être intelligible par des personnes issues de différentes disciplines.
Donner une importante liberté aux auteur·es intérréssé·es par ce format devrait permettre de dégager des tendances, des pratiques, des besoins, des envies, ect…
Les caractèristiques des premiers articles nous permettront de proposer des règles plus précises et une meilleure standardisation de ces articles de méthodes en format notebook.
Datapapers & articles de mèthode
Parce que les méthodes sont aussi hétéroclites que les données, la standardisation des articles de méthodes est aussi complexe que celles des datapapers !
Une revue modèle pour les aspects techniques : Computo (sfds)
La revue Rzine est une de preuve de concept qui permet de :
Groupe de travail sur les enjeux et problématiques du Notebook, pris comme un objet complexe au sein du cycle des données de la recherche.
➡️ Site Web et liste de diffusion du GT Notebook
Code source : https://gitlab.huma-num.fr/rzine/communications/metsem
Diaporama : https://metsem-rzine-communications-24179b2cc4cff52abc887fc720c90e98a96.gitpages.huma-num.fr/
