* L'analyse de l'incidence du syndrome grippal revisitée
Nous allons reprendre l'exemple du module 3, l'analyse de l'incidence du syndrome grippal.
** 1ère étape: le téléchargement des données
Je vais reprendre l'exemple du module 3, l'analyse de l'incidence du syndrome grippal, et je vais refaire exactement la même analyse sous forme d'un workflow par =snakemake=. Ceci veut dire que pour l'instant, nous quittons le monde des documents computationnels que nous vous avons montré dans les modules 2 et 3, pour passer dans l'univers de la ligne de commande. Il y a des bonnes raisons pour cela, que je vous donnerai plus tard. Et vous verrez aussi le retour des documents computationnels à la fin de ce tutoriel, même si ce sera dans un rôle moins central.
Un workflow est composé de tâches dont chacun correspond à un bout du calcul total. Une tâche est typiquement l'exécution d'une commande ou d'un script. Les tâches communiques entre eux par des fichiers - au moins dans la vision de =snakemake= (et d'autres descendants de =make=). Pour faire le lien avec la programmation dans un langage comme Python ou R, une tâche est l'appel à une fonction, et les paramètres et les valeurs de retour sont stockés dans des fichiers.
Il y a beaucoup de liberté dans la décomposition d'un calcul en tâches d'un workflow. Souvent les critères sont plutôt techniques que scientifiques: une tâche peut alors correspondre à l'exécution d'un logiciel, ou à une étape du calcul qui est fait sur un ordinateur précis. Pour mon analyse je propose la décomposition suivante, qui est assez arbitraire :
1. Téléchargement des données du site du Réseau Sentinelles
2. Pré-traitement: extraction des données utilisées, vérifications
3. Visualisation: génération des plots
4. Calcul des incidences annuelles
5. Calcul de l'histogramme des incidences annuelles
Pour faire les calculs, je vais recycler le code du module 3, sans les commenter de nouveau ici.
** Préparation
Un workflow finit par utiliser beaucoup de fichiers, donc je commence par la création d'un répertoire qui contient tout:
#+begin_src sh :session *snakemake* :results output :exports both
mkdir incidence_syndrome_grippal_snakemake
cd incidence_syndrome_grippal_snakemake
#+end_src
#+RESULTS:
En plus, je crée un répertoire pour les fichiers de données,
#+begin_src sh :session *snakemake* :results output :exports both
mkdir data
#+end_src
#+RESULTS:
et un autre pour les scripts en Python ou R:
#+begin_src sh :session *snakemake* :results output :exports both
mkdir scripts
#+end_src
#+RESULTS:
** 1ère tâche: le téléchargement des données
Pour télécharger un fichier, inutile d'écrire du code: l'utilitaire =wget= fait ce qu'il faut. La ligne de commande
#+begin_src sh :session *snakemake* :results output :exports both
fait ce qu'il faut, et dépose les données dans le fichier =data/weekly-incidence.csv=. Je le supprime parce que je veux faire le téléchargement dans mon workflow!
#+begin_src sh :session *snakemake* ::results output :exports both
rm data/weekly-incidence.csv
#+end_src
#+RESULTS:
Je vais commencer la rédaction du =Snakefile=, le fichier qui déinit mon workflow:
#+begin_src :exports both :tangle incidence_syndrome_grippal_snakemake/Snakefile
Un =Snakefile= consiste de /règles/ qui définissent les tâches. Chaque règle a un nom, ici j'ai choisi /download/. Une règle liste aussi les fichiers d'entrée (aucun dans ce cas) et de sortie (notre fichier de données). Enfin, il faut dire ce qui est à faire pour exécuter la tâche, ce qui est ici la commande =wget=.
Pour exécuter cette tâche, il y a deux façons de faire: on peut demander à =snakemake= d'exécuter la règle =download=:
#+begin_src sh :session *snakemake* ::results output :exports both
snakemake download
#+end_src
#+RESULTS:
| Building | DAG | of | jobs... | | | | | | | |
| Using | shell: | /bin/bash | | | | | | | | |
| Provided | cores: | 1 | | | | | | | | |
| Rules | claiming | more | threads | will | be | scaled | down. | | | |
En regardant bien ce que =snakemake= dit au deuxième tour, il s'est rendu compte qu'il n'y a rien à faire, parce que le fichier souhaité existe déjà. Voici un premier avantage important d'un workflow: une tâche n'est exécutée que s'il est nécessaire. Quand une tâche met deux heures à exécuter, c'est appréciable.
** 2ème tâche: le pré-traitement des données
La deuxième tâche est le pré-traitement: en partant du fichier téléchargé du Réseau Sentinelle, il faut extraire juste les éléments nécessaires, et il faut vérifier s'il y a des données manquantes ou des erreurs. Dans un document computationnel, j'avais procédé pas par pas, en inspectant les résultats à chaque étape. Dans mon workflow, le pré-traitement devient une seule tâche, exécutée en bloc.
Il faut donc bien réfléchir à ce qu'on attend comme résultat. En fait, il faut deux fichiers de sortie: un qui contient les données qui seront analysées par la suite, et un autre qui contient les éventuels messages d'erreur. Avec ça, la deuxième règle s'écrit assez vite:
#+begin_src :exports both :tangle incidence_syndrome_grippal_snakemake/Snakefile
rule preprocess:
input:
"data/weekly-incidence.csv"
output:
data="data/preprocessed-weekly-incidence.csv",
errorlog="data/errors-from-preprocessing.txt"
script:
"scripts/preprocess.py"
#+end_src
Il y a donc un fichier d'entrée, qui est le résultat de la tâche /download/. Et il y a les deux fichiers de sortie. Enfin, pour faire le travail, j'ai opté pour un script Python cette fois. =snakemake= reconnaît le langage par l'extension =.py=.
Le contenu de ce script est presque un copier-coller d'un document computationnel du module 3, plus précisément du document que j'ai montré dans le parcours Emacs/Org-Mode:
#+begin_src python :exports both :tangle incidence_syndrome_grippal_snakemake/scripts/preprocess.py
# Libraries used by this script:
import datetime # for date conversion
import csv # for writing output to a CSV file
# Read the CSV file into memory
data = open(snakemake.input[0], 'rb').read()
# Decode the Latin-1 character set,
# remove white space at both ends,
# and split into lines.
lines = data.decode('latin-1') \
.strip() \
.split('\n')
# Discard the first line, which contains a comment
data_lines = lines[1:]
# Split each line into columns
table = [line.split(',') for line in data_lines]
# Remove records with missing data and write
# the removed records to a separate file for inspection.
with open(snakemake.output.errorlog, "w") as errorlog:
valid_table = []
for row in table:
missing = any([column == '' for column in row])
if missing:
errorlog.write("Missing data in record\n")
errorlog.write(str(row))
errorlog.write("\n")
else:
valid_table.append(row)
# Extract the two relevant columns, "week" and "inc"
week = [row[0] for row in valid_table]
assert week[0] == 'week'
del week[0]
inc = [row[2] for row in valid_table]
assert inc[0] == 'inc'
del inc[0]
data = list(zip(week, inc))
# Check for obviously out-of-range values
with open(snakemake.output.errorlog, "a") as errorlog:
for week, inc in data:
if len(week) != 6 or not week.isdigit():
errorlog.write("Suspect value in column 'week': {week}\n")
if not inc.isdigit():
errorlog.write("Suspect value in column 'inc': {inc}\n")
# Convert year/week by date of the corresponding Monday,
Ce qui saute aux yeux d'abord, c'est =snakemake.input[0]= comme nom de fichier. Le nom =snakemake= semble venir de nulle part: il n'est ni défini dans le script, ni importé d'un module. En fait, c'est bien =snakemake= qui définit ce nom dans l'interprète Python avant de lancer le script. Il permet d'accèder aux définitions du =Snakefile=, et notamment aux noms des fichiers.
Sinon, il y a deux modifications par rapport au code du module 3. Premièrement, les messages d'erreurs sont écrits dans un fichier. Deuxièmement, les données finales sont écrites également dans un fichier, en utilisant le format CSV.
Pour appliquer le pré-traitement, demandons à =snakemake=:
#+begin_src sh :session *snakemake* :results output :exports both
