requipso 0.2.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (75) hide show
  1. requipso/__init__.py +27 -0
  2. requipso/cli.py +11 -0
  3. requipso/completer.py +103 -0
  4. requipso/data.py +72 -0
  5. requipso/descriptive_pipeline.py +271 -0
  6. requipso/docs/macros.py +226 -0
  7. requipso/docs/mkdocs.yml +140 -0
  8. requipso/docs/pages/assets/consort_flowchart.png +0 -0
  9. requipso/docs/pages/assets/demo.gif +0 -0
  10. requipso/docs/pages/blocs/age.md +61 -0
  11. requipso/docs/pages/blocs/ald.md +65 -0
  12. requipso/docs/pages/blocs/biometry.md +98 -0
  13. requipso/docs/pages/blocs/cim10.md +80 -0
  14. requipso/docs/pages/blocs/cisp2.md +59 -0
  15. requipso/docs/pages/blocs/code-postal.md +47 -0
  16. requipso/docs/pages/blocs/consultations.md +65 -0
  17. requipso/docs/pages/blocs/departement.md +50 -0
  18. requipso/docs/pages/blocs/est-vivant.md +44 -0
  19. requipso/docs/pages/blocs/genre.md +46 -0
  20. requipso/docs/pages/blocs/index.md +40 -0
  21. requipso/docs/pages/blocs/insurance.md +55 -0
  22. requipso/docs/pages/blocs/medecin-traitant.md +56 -0
  23. requipso/docs/pages/blocs/paquet-annees.md +70 -0
  24. requipso/docs/pages/blocs/prescription-atc.md +69 -0
  25. requipso/docs/pages/blocs/regex-consultation.md +64 -0
  26. requipso/docs/pages/blocs/regex-nlp.md +107 -0
  27. requipso/docs/pages/blocs/regex-patient-observation.md +81 -0
  28. requipso/docs/pages/blocs/regex-prescription.md +64 -0
  29. requipso/docs/pages/guide/application.md +81 -0
  30. requipso/docs/pages/guide/combiner-blocs.md +61 -0
  31. requipso/docs/pages/guide/demarrage.md +74 -0
  32. requipso/docs/pages/guide/erreurs.md +83 -0
  33. requipso/docs/pages/guide/exemple-complet.md +67 -0
  34. requipso/docs/pages/guide/google-sheet.md +50 -0
  35. requipso/docs/pages/guide/onglet-inclusion.md +91 -0
  36. requipso/docs/pages/guide/onglet-projet.md +48 -0
  37. requipso/docs/pages/guide/onglet-tableau-descriptif.md +124 -0
  38. requipso/docs/pages/guide/parametres.md +162 -0
  39. requipso/docs/pages/index.md +73 -0
  40. requipso/docs/pages/stylesheets/extra.css +3 -0
  41. requipso/docs/pages/technique/ajouter-un-bloc.md +147 -0
  42. requipso/docs/pages/technique/architecture.md +80 -0
  43. requipso/docs/pages/technique/blocs-internes.md +176 -0
  44. requipso/docs/pages/technique/chargement-sheet.md +107 -0
  45. requipso/docs/pages/technique/developpement.md +124 -0
  46. requipso/docs/pages/technique/donnees.md +106 -0
  47. requipso/docs/pages/technique/export-signatures.md +131 -0
  48. requipso/docs/pages/technique/nlp.md +82 -0
  49. requipso/docs/pages/technique/parametres-internes.md +140 -0
  50. requipso/docs/pages/technique/pipeline.md +66 -0
  51. requipso/docs/pages/technique/tableau-descriptif.md +74 -0
  52. requipso/google.py +168 -0
  53. requipso/io.py +95 -0
  54. requipso/notebooks/marimo/run.py +352 -0
  55. requipso/pipeline.py +364 -0
  56. requipso/pipeline_loader.py +572 -0
  57. requipso/pipes/__init__.py +43 -0
  58. requipso/pipes/atcd.py +365 -0
  59. requipso/pipes/base.py +431 -0
  60. requipso/pipes/biometry.py +170 -0
  61. requipso/pipes/consultations.py +117 -0
  62. requipso/pipes/insurance.py +90 -0
  63. requipso/pipes/params.py +283 -0
  64. requipso/pipes/patient.py +377 -0
  65. requipso/pipes/prescription.py +134 -0
  66. requipso/pipes/processors.py +250 -0
  67. requipso/polars.py +24 -0
  68. requipso/resources/pathology/__init__.py +7 -0
  69. requipso/signature_exporter.py +473 -0
  70. requipso/stats.py +130 -0
  71. requipso-0.2.2.dist-info/METADATA +102 -0
  72. requipso-0.2.2.dist-info/RECORD +75 -0
  73. requipso-0.2.2.dist-info/WHEEL +5 -0
  74. requipso-0.2.2.dist-info/entry_points.txt +2 -0
  75. requipso-0.2.2.dist-info/top_level.txt +1 -0
@@ -0,0 +1,50 @@
1
+ # Le Google Sheet
2
+
3
+ Toute la définition d'une étude tient dans un Google Sheet copié depuis le **template**. Requipso lit
4
+ certains onglets et en écrit d'autres. Les onglets dont le nom commence par 🔒 sont remplis
5
+ automatiquement : **ne les modifiez pas à la main**.
6
+
7
+ | Onglet | Vous le remplissez ? | Rôle |
8
+ | --- | --- | --- |
9
+ | `Project` | Oui | Date de référence de l'étude et liste des populations à décrire. Voir [Onglet Project](onglet-projet.md). |
10
+ | `Explications` | Non (à lire) | Aide-mémoire intégré au template. |
11
+ | `Inclusion` | Oui | Les étapes du flowchart d'inclusion. Voir [Onglet Inclusion](onglet-inclusion.md). |
12
+ | `Descriptive_table` | Oui | Les variables du tableau descriptif. Voir [Onglet Descriptive_table](onglet-tableau-descriptif.md). |
13
+ | `🔒 Results` | Non | Le tableau descriptif calculé, réécrit à chaque exécution. |
14
+ | `🔒 Blocks` | Non | Référence : la liste des blocs disponibles, leur description et leurs valeurs par défaut. |
15
+ | `🔒 Definitions` | Non | Référence : les paramètres spécifiques de chaque bloc (à mettre dans `supplementary_params`). |
16
+
17
+
18
+ ## Règles générales de saisie
19
+
20
+ Ces règles valent pour les onglets `Inclusion` et `Descriptive_table`.
21
+
22
+ **La première ligne contient les noms de colonnes.** Ne les renommez pas : Requipso les recherche par
23
+ leur nom exact (`block_name`, `block_type`, `value`…). L'ordre des colonnes n'a en revanche pas
24
+ d'importance.
25
+
26
+ **Une ligne sans `block_type` est ignorée.** Vous pouvez donc laisser des lignes vides, ou écrire des
27
+ notes dans une ligne sans bloc.
28
+
29
+ **Une cellule vide signifie « valeur par défaut du bloc ».** Par exemple, le bloc `Age` a par défaut
30
+ `post_func = x>=18` : si vous laissez `post_func` vide, Requipso garde les patients majeurs.
31
+ Pour obtenir la valeur brute (l'âge lui-même), il faut écrire explicitement `x`. Les valeurs par
32
+ défaut de chaque bloc sont indiquées dans le [catalogue des blocs](../blocs/index.md) et dans l'onglet
33
+ `🔒 Blocks`.
34
+
35
+ **Les listes de valeurs** s'écrivent au choix :
36
+
37
+ - en séparant par une barre verticale : `E11|E10|E14` ;
38
+ - au format liste : `["E11", "E10", "E14"]`.
39
+
40
+ **Les cases à cocher** (colonne `expose_date_for_future_references`) doivent être de vraies cases à
41
+ cocher Google Sheet (valeurs `TRUE` / `FALSE`).
42
+
43
+ **Les dates** s'écrivent `JJ/MM/AAAA` dans l'onglet `Project`. Dans les formules SQL, on écrit
44
+ `DATE 'AAAA-MM-JJ'` (voir [Paramètres](parametres.md)).
45
+
46
+ ## Ce que Requipso écrit dans votre feuille et votre Drive
47
+
48
+ - L'onglet `🔒 Results` est **entièrement effacé puis réécrit** à chaque calcul du tableau descriptif.
49
+ - Le flowchart est déposé dans le dossier Drive sous le nom `<nom de votre feuille>.png`.
50
+ S'il existe déjà, il est remplacé.
@@ -0,0 +1,91 @@
1
+ # Onglet `Inclusion`
2
+
3
+ L'onglet `Inclusion` décrit le **flowchart d'inclusion** : une suite d'étapes, chacune ne gardant
4
+ qu'une partie des patients de l'étape précédente.
5
+
6
+ ![Exemple de flowchart avec branches](../assets/consort_flowchart.png){ width="480" }
7
+
8
+ ## Le principe
9
+
10
+ - Chaque **étape** est une boîte du flowchart. Elle est définie par une ligne (ou un
11
+ [groupe de lignes](combiner-blocs.md)) de l'onglet.
12
+ - Une étape applique un **bloc** (ex. `Age`) qui calcule une valeur par patient, puis une condition
13
+ (ex. `x>=18`) qui dit si le patient est **retenu** (`TRUE`) ou **exclu** (`FALSE` ou vide).
14
+ - Une étape n'est évaluée que sur les patients **retenus par son étape parente**. Le nombre affiché
15
+ `(n=…)` est le nombre de patients retenus ; la boîte « Excluded » affiche la différence avec le parent.
16
+ - Tout en haut, une boîte `Patients` indique le nombre total de patients de la base.
17
+
18
+ !!! important "Une étape d'inclusion doit renvoyer vrai/faux"
19
+ Dans l'onglet `Inclusion`, la valeur finale d'un bloc (après `post_func`) doit être un booléen.
20
+ Les valeurs par défaut des blocs sont prévues pour ça (ex. `Age` → `x>=18`,
21
+ `CIM10` → `x>=1`, c'est-à-dire « au moins un code trouvé »).
22
+
23
+ ## Les colonnes
24
+
25
+ | Colonne | Obligatoire | Description |
26
+ | --- | --- | --- |
27
+ | `block_name` | Oui | Nom **unique** de l'étape. Il sert à y faire référence ailleurs (`parent_step`, `reference_date_block`, populations). Préférez des noms courts sans caractères spéciaux (ex. `adultes`, `diabete_t2`). |
28
+ | `block_type` | Oui | Le bloc à utiliser, par ex. `Age`, `CIM10`, `Consultations`. Voir le [catalogue](../blocs/index.md). Une ligne sans `block_type` est ignorée. |
29
+ | `parent_step` | Non | Le `block_name` de l'étape parente. **Vide = l'étape définie juste au-dessus dans la feuille.** Doit rester vide pour la toute première étape. |
30
+ | `text` | Non | Texte affiché dans la boîte du flowchart (ex. `Patients majeurs`). |
31
+ | `excluded_text` | Non | Texte de la boîte d'exclusion à droite (ex. `Mineurs`). Vide = pas de boîte d'exclusion. |
32
+ | `operator` | Pour les groupes | `AND` ou `OR`, uniquement sur les lignes 2, 3… d'un groupe. Voir [Combiner des blocs](combiner-blocs.md). |
33
+ | `expose_date_for_future_references` | Pour les groupes | Case à cocher. Dans un groupe, indique si les dates de cette ligne sont utilisables par `reference_date_block`. Voir [Combiner des blocs](combiner-blocs.md#dates-dun-groupe). |
34
+ | `value` | Selon le bloc | La valeur principale du bloc (codes CIM10, libellé de biométrie…). |
35
+ | `agg_func` | Non | Comment résumer plusieurs événements d'un patient (ex. `COUNT(x)`). Nécessaire pour les blocs de type ` event` (qui peuvent produire plus d'une valeur par patient)|
36
+ | `post_func` | Non | La condition finale (ex. `x>=18`). |
37
+ | `date_sql` | Non | Filtre temporel sur les événements. |
38
+ | `reference_date_block` | Non | Étape antérieure fournissant une date de référence propre à chaque patient. |
39
+ | `reference_date_sql` | Non | Quelle date prendre dans `reference_date_block` (défaut `MIN(start_date)`). |
40
+ | `supplementary_params` | Non | Paramètres spécifiques au bloc, au format `{"nom": valeur}`. |
41
+
42
+ Les colonnes `value` à `supplementary_params` sont détaillées dans [Paramètres des blocs](parametres.md).
43
+
44
+ ## Exemple : une chaîne simple
45
+
46
+ | block_name | parent_step | text | excluded_text | block_type | value | post_func | date_sql |
47
+ | --- | --- | --- | --- | --- | --- | --- | --- |
48
+ | `vivants` | | Patients vivants | Décédés | `EstVivant` | | | |
49
+ | `adultes` | | Patients majeurs | Mineurs | `Age` | | | |
50
+ | `diabete` | | Diabète de type 2 | Sans diabète T2 | `CIM10` | `E11` | | |
51
+ | `suivis` | | Consultation dans l'année | Pas de consultation récente | `Consultations` | | | `start_date >= reference_date - INTERVAL '1 year' AND start_date <= reference_date` |
52
+
53
+ `parent_step` est vide partout : chaque étape s'enchaîne sur la précédente. Le flowchart obtenu est :
54
+
55
+ ```mermaid
56
+ flowchart TB
57
+ p["Patients (n=…)"] --> v["Patients vivants (n=…)"]
58
+ v --> a["Patients majeurs (n=…)"]
59
+ a --> d["Diabète de type 2 (n=…)"]
60
+ d --> s["Consultation dans l'année (n=…)"]
61
+ v -.-> e1["Excluded : Mineurs"]
62
+ a -.-> e2["Excluded : Sans diabète T2"]
63
+ d -.-> e3["Excluded : Pas de consultation récente"]
64
+ ```
65
+
66
+ ## Exemple : des branches
67
+
68
+ Pour séparer un groupe en plusieurs sous-groupes (« bras »), donnez à plusieurs étapes le **même
69
+ parent** :
70
+
71
+ | block_name | parent_step | text | block_type | value | post_func |
72
+ | --- | --- | --- | --- | --- | --- |
73
+ | `adultes` | | Patients majeurs | `Age` | | |
74
+ | `femmes` | `adultes` | Femmes | `Genre` | | `x = 'féminin'` |
75
+ | `hommes` | `adultes` | Hommes | `Genre` | | `x = 'masculin'` |
76
+ | `hommes_diab` | `hommes` | Hommes diabétiques | `CIM10` | `E11` | |
77
+
78
+ `femmes` et `hommes` sont côte à côte sous `adultes`, et `hommes_diab` poursuit la branche `hommes`.
79
+
80
+ !!! warning "Attention au `parent_step` vide après une branche"
81
+ Un `parent_step` vide signifie « l'étape **écrite juste au-dessus dans la feuille** », pas « la
82
+ dernière étape de la branche principale ». Après avoir défini des branches, renseignez toujours
83
+ explicitement `parent_step`.
84
+
85
+ ## Bonnes pratiques
86
+
87
+ - **Construisez progressivement** : ajoutez une étape, lancez, vérifiez les effectifs, puis continuez.
88
+ - **Gardez des noms stables** : les noms d'étapes sont réutilisés dans les populations et les
89
+ références de date ; les renommer oblige à mettre à jour ces références.
90
+ - Une étape ne peut référencer (en `parent_step` ou `reference_date_block`) qu'une étape **située
91
+ plus haut** dans la feuille.
@@ -0,0 +1,48 @@
1
+ # Onglet `Project`
2
+
3
+ L'onglet `Project` contient deux informations, à des emplacements **fixes** :
4
+
5
+ | | A | B | C | D |
6
+ | --- | --- | --- | --- | --- |
7
+ | **1** | **Date de référence (double-click sur B1 pour choisir la date)** | `01/01/2024` | | |
8
+ | **2** | **`Populations`** | `Adultes` | `Diabétiques` | `Diabétiques_suivis` |
9
+
10
+ ## La date de référence (cellule B1)
11
+
12
+ C'est la date « à laquelle on regarde » les patients. Elle sert par défaut à tous les blocs :
13
+
14
+ - `Age` calcule l'âge **à cette date** ;
15
+ - `EstVivant` vérifie que le patient est vivant **à cette date** ;
16
+ - les filtres temporels (`date_sql`) peuvent la comparer aux dates des événements, par exemple
17
+ « consultation dans l'année précédant la date de référence ».
18
+
19
+ Format obligatoire : `JJ/MM/AAAA` (ex. `31/12/2023`).
20
+
21
+ !!! tip "Une date de référence par patient"
22
+ Il est aussi possible d'utiliser une date propre à chaque patient (par exemple la date de son
23
+ premier diagnostic de diabète) pour certains blocs. C'est le rôle de la colonne
24
+ `reference_date_block` : voir [Paramètres](parametres.md#date-de-reference-par-patient).
25
+
26
+ ## Les populations (ligne 2)
27
+
28
+ La cellule **A2 doit contenir exactement** le mot `Populations`. Les cellules suivantes (B2, C2, …)
29
+ contiennent chacune le nom d'une population, à renseigner via une liste déroulante.
30
+
31
+ Une population est simplement le **nom d'une étape** de l'onglet `Inclusion` (sa colonne
32
+ `block_name`). Les patients ayant franchi cette étape forment une colonne du tableau descriptif.
33
+
34
+ - Les noms doivent correspondre **exactement** (majuscules, accents, espaces) à un `block_name` de
35
+ l'onglet `Inclusion` (utilisez directement la liste déroulante pour être sûr).
36
+ - L'ordre des cellules donne l'ordre des colonnes du tableau descriptif.
37
+ - La **première** population sert de dénominateur pour la ligne `Total` du tableau : les pourcentages
38
+ de cette ligne sont exprimés par rapport à elle. Placez donc en premier la population la plus large.
39
+
40
+ !!! info "Quand remplir les populations ?"
41
+ Les populations ne sont utilisées que pour le tableau descriptif. Vous pouvez commencer par
42
+ construire et vérifier votre flowchart, puis renseigner les populations une fois les noms
43
+ d'étapes stabilisés.
44
+
45
+ !!! warning "Changer la date de référence"
46
+ L'application ne recalcule l'inclusion que si l'onglet `Inclusion` a changé. Si vous modifiez
47
+ **uniquement** la date de référence, rechargez la page de l'application (ou relancez-la) pour
48
+ forcer un recalcul complet. Voir [Utiliser l'application](application.md#recalcul-automatique).
@@ -0,0 +1,124 @@
1
+ # Onglet `Descriptive_table`
2
+
3
+ L'onglet `Descriptive_table` décrit les **variables** du tableau descriptif. Chaque variable est
4
+ calculée pour chacune des [populations](onglet-projet.md#les-populations-ligne-2) déclarées dans
5
+ l'onglet `Project`. Le résultat est écrit dans l'onglet `🔒 Results`.
6
+
7
+ La struture de cet onglet est très proche de l'onglet `Inclusion`
8
+
9
+ ## Le principe
10
+
11
+ - Une ligne (ou un [groupe de lignes](combiner-blocs.md)) = une variable du tableau.
12
+ - On utilise les **mêmes blocs** que dans l'onglet `Inclusion`, mais leur résultat n'a pas à être
13
+ vrai/faux : ce peut être un nombre (âge, IMC), une catégorie (genre) ou un booléen (diabétique ou non).
14
+ - La colonne `variable_type` indique comment résumer la variable.
15
+
16
+ ## Les colonnes
17
+
18
+ | Colonne | Obligatoire | Description |
19
+ | --- | --- | --- |
20
+ | `block_name` | Oui | Nom unique de la variable. **Il doit être différent de tous les noms de l'onglet `Inclusion`.** C'est ce nom qui apparaît comme titre dans `🔒 Results`. |
21
+ | `block_type` | Oui | Le bloc à utiliser (voir le [catalogue](../blocs/index.md)). |
22
+ | `variable_type` | Oui | `boolean`, `numerical` ou `categorical` (voir ci-dessous). |
23
+ | `variable_description` | Non | Libellé lisible, affiché dans la barre de progression de l'application. |
24
+ | `subsets` | Non | Découpage en classes (variables numériques) ou regroupement de catégories (voir ci-dessous). |
25
+ | `operator` | Pour les groupes | `AND` / `OR`, comme dans l'onglet `Inclusion`. |
26
+ | `value`, `agg_func`, `post_func`, `date_sql`, `reference_date_block`, `reference_date_sql`, `supplementary_params` | Non | Identiques à l'onglet `Inclusion`. Voir [Paramètres](parametres.md). |
27
+
28
+ !!! tip "Référencer une étape d'inclusion"
29
+ `reference_date_block` peut pointer vers une étape de l'onglet `Inclusion` (ex. la date du premier
30
+ diagnostic) ou vers une variable définie plus haut dans cet onglet.
31
+
32
+ ## Choisir `variable_type` et `post_func`
33
+
34
+ C'est le point qui demande le plus d'attention. Les valeurs par défaut des blocs sont pensées pour
35
+ l'inclusion (elles renvoient vrai/faux). Pour une variable numérique ou catégorielle, il faut donc
36
+ **écrire `x` dans `post_func`** pour garder la valeur brute.
37
+
38
+ | Je veux… | `variable_type` | `post_func` | Exemple |
39
+ | --- | --- | --- | --- |
40
+ | un pourcentage de patients | `boolean` | une condition, ou vide si la valeur par défaut convient | `CIM10` avec `value = I10` → % d'hypertendus |
41
+ | une moyenne / médiane | `numerical` | `x` | `Age` avec `post_func = x` |
42
+ | une répartition par catégorie | `categorical` | `x` | `Genre` avec `post_func = x` |
43
+ | un nombre d'événements | `numerical` | `x` (ou `COALESCE(x, 0)`) | `Consultations` avec `agg_func = COUNT(x)` |
44
+
45
+ Si le type ne correspond pas, Requipso s'arrête avec un message du type
46
+ `Column age is not numeric (got Boolean), but variable_type is numerical. Maybe check post_func ?`.
47
+
48
+ ## Les statistiques calculées
49
+
50
+ ### `boolean`
51
+
52
+ | Ligne | Contenu |
53
+ | --- | --- |
54
+ | `(n, %)` | Nombre et pourcentage de patients pour lesquels la valeur est vraie. |
55
+ | `missing (n, %)` | Nombre et pourcentage de patients sans valeur. |
56
+
57
+ !!! warning "« missing » pour les blocs qui comptent des événements"
58
+ Pour les blocs du type « au moins un événement » (`CIM10`, `Consultations`, `PrescriptionATC`…),
59
+ un patient qui n'a **aucun** événement n'a pas de valeur : il est compté en `missing`, pas en
60
+ « faux ». Le pourcentage `(n, %)` reste juste (il est calculé sur toute la population), mais si
61
+ vous voulez que ces patients soient comptés comme « non », écrivez
62
+ `post_func = COALESCE(x, 0) >= 1`.
63
+
64
+ ### `numerical`
65
+
66
+ | Ligne | Contenu |
67
+ | --- | --- |
68
+ | `(mean ± std)` | Moyenne ± écart-type. |
69
+ | `(median, IQR)` | Médiane [1er quartile - 3e quartile]. |
70
+ | `missing (n, %)` | Patients sans valeur. |
71
+ | `[a - b[ (n, %)` | Une ligne par classe si `subsets` est renseigné. |
72
+
73
+ `subsets` contient les **bornes inférieures** des classes. Par exemple `[0, 18, 45, 65]` donne les
74
+ classes `[0 - 18[`, `[18 - 45[`, `[45 - 65[` et `65+`. Les valeurs inférieures à la première borne ne
75
+ sont comptées dans aucune classe.
76
+
77
+ ### `categorical`
78
+
79
+ Une ligne `(n, %)` par catégorie. Sans `subsets`, toutes les valeurs rencontrées sont listées.
80
+
81
+ `subsets` permet de choisir et d'ordonner les catégories, et d'en **regrouper** certaines :
82
+
83
+ ```text
84
+ ["féminin", ["masculin", "non genré"]]
85
+ ```
86
+
87
+ donne deux lignes : `féminin` et `(masculin, non genré)`.
88
+
89
+ !!! note "Valeurs manquantes des variables catégorielles"
90
+ La ligne `missing` d'une variable catégorielle affiche actuellement toujours 0. Les patients
91
+ sans valeur ne sont comptés dans aucune catégorie : leur nombre est la différence entre l'effectif
92
+ de la population et la somme des catégories.
93
+
94
+ ## Lire l'onglet `🔒 Results`
95
+
96
+ Le tableau a une colonne par population, dans l'ordre de l'onglet `Project`. Chaque variable commence
97
+ par une ligne de titre (en bleu, avec le `block_name`), suivie de ses statistiques :
98
+
99
+ | | adultes | diabete |
100
+ | --- | --- | --- |
101
+ | **Total** | | |
102
+ | (n, %) | 52000 (100.0%) | 4100 (7.88%) |
103
+ | **age** | | |
104
+ | (mean ± std) | 47.2 ± 17.9 | 63.1 ± 12.4 |
105
+ | (median, IQR) | 45.0 [33.1 - 60.2] | 64.0 [55.3 - 72.0] |
106
+ | missing (n, %) | 0 (0.0%) | 0 (0.0%) |
107
+
108
+ La ligne `Total` donne l'effectif de chaque population, en pourcentage de la **première** population.
109
+ Tous les autres pourcentages sont calculés par rapport à l'effectif de **la population de la colonne**.
110
+
111
+ Le tableau est aussi affiché dans l'application, en bas de page.
112
+
113
+ ## Exemple
114
+
115
+ | block_name | block_type | variable_type | variable_description | value | agg_func | post_func | subsets |
116
+ | --- | --- | --- | --- | --- | --- | --- | --- |
117
+ | `age` | `Age` | `numerical` | Âge (années) | | | `x` | `[18, 45, 65]` |
118
+ | `genre` | `Genre` | `categorical` | Genre | | | `x` | `["féminin", "masculin"]` |
119
+ | `hta` | `CIM10` | `boolean` | Hypertension artérielle | `I10` | | `COALESCE(x, 0) >= 1` | |
120
+ | `imc` | `Biometry` | `numerical` | IMC (dernier connu) | `bmi` | | | `[0, 18.5, 25, 30]` |
121
+ | `nb_cs` | `Consultations` | `numerical` | Nombre de consultations sur 1 an | | | `COALESCE(x, 0)` | |
122
+
123
+ Pour `nb_cs`, on ajoute `date_sql = start_date >= reference_date - INTERVAL '1 year' AND start_date <= reference_date`.
124
+ Pour `imc`, `post_func` est vide car la valeur par défaut de `Biometry` est déjà `x`.
@@ -0,0 +1,162 @@
1
+ # Paramètres des blocs
2
+
3
+ Tous les blocs partagent les mêmes colonnes de paramètres : `value`, `agg_func`, `post_func`,
4
+ `date_sql`, `reference_date_block`, `reference_date_sql` et `supplementary_params`. Cette page
5
+ explique à quoi sert chacune, avec des exemples prêts à copier.
6
+
7
+ ## Comment un bloc calcule sa valeur
8
+
9
+ Comprendre ce parcours en 4 temps permet de savoir dans quelle colonne agir.
10
+
11
+ ```mermaid
12
+ flowchart LR
13
+ A["1. Le bloc lit les données<br/>une ligne par événement<br/>(valeur x + dates)"] --> B["2. date_sql<br/>garde les événements<br/>dans la bonne période"]
14
+ B --> C["3. agg_func<br/>résume les événements<br/>d'un patient en une valeur"]
15
+ C --> D["4. post_func<br/>transforme la valeur<br/>(ex. condition vrai/faux)"]
16
+ ```
17
+
18
+ Prenons le bloc `Consultations` pour un patient qui a eu 3 consultations, dont 2 en 2023 :
19
+
20
+ | Temps | Ce qui se passe | Résultat pour ce patient |
21
+ | --- | --- | --- |
22
+ | 1. Lecture | Une ligne par consultation, avec sa date. | 3 lignes |
23
+ | 2. `date_sql = EXTRACT(YEAR FROM start_date) = 2023` | On ne garde que les consultations de 2023. | 2 lignes |
24
+ | 3. `agg_func = COUNT(x)` (défaut) | On compte. | `2` |
25
+ | 4. `post_func = x>=1` (défaut) | Au moins une consultation ? | `TRUE` |
26
+
27
+ Un patient **sans aucune ligne** après l'étape 2 n'a pas de valeur (cellule vide, « null »).
28
+ Les conditions sur une valeur vide donnent « vide », qui est traité comme **exclu** dans le flowchart
29
+ et comme **missing** dans le tableau descriptif (voir `COALESCE` plus bas).
30
+
31
+ Les blocs « patient » (`Age`, `Genre`…) ont directement une seule ligne par patient : l'étape 3 n'a
32
+ pas lieu (pas d'`agg_func` par défaut).
33
+
34
+ ## `value` : la valeur principale
35
+
36
+ Son sens dépend du bloc : codes CIM10 pour `CIM10`, libellé de mesure pour `Biometry`, motifs regex
37
+ pour `RegexConsultation`… La fiche de chaque bloc indique ce qu'il attend. Certains blocs n'utilisent
38
+ pas `value` (`Age`, `Genre`, `Consultations`…) : laissez-la vide.
39
+
40
+ Pour plusieurs valeurs, séparez-les par `|` : `E11|E10`, ou écrivez une liste `["E11", "E10"]`.
41
+
42
+ !!! warning "Valeurs qui ressemblent à des nombres"
43
+ Si **toutes** les cellules remplies de la colonne `value` sont des nombres (ex. un seul bloc
44
+ `CodePostal` avec `75011`), Google Sheet les transmet comme des nombres et le bloc échoue avec
45
+ `Input should be a valid list`. Le zéro initial peut aussi disparaître (`06` devient `6`).
46
+ Dans ce cas, écrivez la valeur sous forme de liste : `["75011"]`, `["06"]`.
47
+
48
+ ## La lettre `x`
49
+
50
+ Dans `agg_func` et `post_func`, **`x` désigne la valeur calculée par le bloc**. Requipso la remplace
51
+ automatiquement par la bonne colonne.
52
+
53
+
54
+ ## `agg_func` : résumer plusieurs événements
55
+
56
+ !!! tip "SQL dans `agg_func`"
57
+ Vous pouvez inscrire n'importe quelle expression SQL valide pour `agg_func`
58
+
59
+ | Formule | Résultat |
60
+ | --- | --- |
61
+ | `COUNT(x)` | Nombre d'événements. |
62
+ | `COUNT(DISTINCT x)` | Nombre de valeurs différentes (ex. nombre de codes CIM10 distincts). |
63
+ | `SUM(x)` | Somme. |
64
+ | `MIN(x)` / `MAX(x)` | Plus petite / plus grande valeur. |
65
+ | `AVG(x)` | Moyenne (`MEAN` n'existe pas, utilisez `AVG`). |
66
+ | `MEDIAN(x)` | Médiane. |
67
+ | `FIRST(x)` / `LAST(x)` | Valeur du **plus ancien** / du **plus récent** événement (les événements sont triés par date). |
68
+
69
+ !!! note "On ne peut pas « désactiver » une agrégation par défaut"
70
+ Laisser `agg_func` vide applique la valeur par défaut du bloc (souvent `COUNT(x)`). Pour obtenir
71
+ par exemple *le* code CIM10 d'un patient plutôt que leur nombre, choisissez une autre agrégation
72
+ comme `FIRST(x)` ou `LAST(x)`.
73
+
74
+ ## `post_func` : transformer la valeur finale
75
+
76
+ !!! tip "SQL dans `post_func`"
77
+ Vous pouvez inscrire n'importe quelle expression SQL valide pour `post_func`.
78
+ **Par définition, dans l'onglet `Inclusion` cependant, il faut renvoyer un booléen**
79
+
80
+ | Formule | Signification |
81
+ | --- | --- |
82
+ | `x` | Garder la valeur telle quelle (indispensable pour une variable numérique ou catégorielle). |
83
+ | `x>=18`, `x<5`, `x<>0` | Comparaisons (`<>` signifie « différent de »). |
84
+ | `x >= 18 AND x < 65` | Combinaison de conditions (`AND`, `OR`, `NOT`). |
85
+ | `x = 'féminin'` | Égalité avec un texte (guillemets simples ou doubles ; `==` est aussi accepté). |
86
+ | `x IN ('masculin', 'féminin')` | Appartenance à une liste. |
87
+ | `x LIKE 'E11%'` | Le texte commence par `E11` (`%` = n'importe quelle suite de caractères). |
88
+ | `x IS NULL` / `x IS NOT NULL` | Pas de valeur / une valeur existe. |
89
+ | `COALESCE(x, 0) >= 1` | Remplace l'absence de valeur par 0 avant de comparer : les patients sans événement deviennent `FALSE` au lieu de vide. |
90
+ | `ROUND(x, 1)` | Arrondi à 1 décimale. |
91
+ | `SUBSTR(x, 1, 2)` | Les 2 premiers caractères (ex. département à partir d'un code postal). |
92
+ | `CASE WHEN x >= 65 THEN 'senior' ELSE 'non senior' END` | Créer des catégories. |
93
+
94
+ ## `date_sql` : filtrer dans le temps
95
+
96
+ `date_sql` est une condition appliquée **à chaque événement, avant l'agrégation**. Elle peut utiliser :
97
+
98
+ | Nom | Signification |
99
+ | --- | --- |
100
+ | `start_date` | Date de début de l'événement (ou date unique, ex. date d'une mesure). |
101
+ | `end_date` | Date de fin (ex. fin d'une prescription). Si elle est vide (événement en cours), elle vaut la date du jour. |
102
+ | `reference_date` | La date de référence (de l'onglet `Project`, ou propre au patient via `reference_date_block`). |
103
+
104
+ La fiche de chaque bloc précise quelles dates il fournit. Sur un bloc sans date (ex. `Genre`), le
105
+ `date_sql` est **ignoré sans message d'erreur**. La formule doit contenir `start_date` ou `end_date`.
106
+
107
+ ### Recettes
108
+
109
+ | Je veux les événements… | `date_sql` |
110
+ | --- | --- |
111
+ | avant la date de référence | `start_date <= reference_date` |
112
+ | dans l'année précédant la date de référence | `start_date >= reference_date - INTERVAL '1 year' AND start_date <= reference_date` |
113
+ | dans les 6 mois après la date de référence | `start_date >= reference_date AND start_date <= reference_date + INTERVAL '6 months'` |
114
+ | dans les 90 jours avant | `start_date BETWEEN reference_date - INTERVAL '90 days' AND reference_date` |
115
+ | en cours à la date de référence (ex. traitement, médecin traitant) | `start_date <= reference_date AND end_date >= reference_date` |
116
+ | depuis une date fixe | `start_date >= DATE '2023-01-01'` |
117
+ | d'une année donnée | `EXTRACT(YEAR FROM start_date) = 2023` |
118
+
119
+ !!! warning "Écrire une date fixe"
120
+ Une date fixe doit être précédée du mot `DATE` et écrite `AAAA-MM-JJ` : `DATE '2023-01-01'`.
121
+ Écrire `start_date >= '2023-01-01'` provoque une erreur.
122
+
123
+ ## Date de référence par patient
124
+
125
+ Par défaut, tous les patients partagent la date de référence de l'onglet `Project`. Il est souvent
126
+ plus pertinent d'utiliser une date **propre à chaque patient**, par exemple « dans l'année qui suit
127
+ le premier diagnostic de diabète ».
128
+
129
+ - `reference_date_block` : le `block_name` d'une étape (ou variable) **définie plus haut**, qui porte
130
+ des dates.
131
+ - `reference_date_sql` : quelle date retenir parmi les événements de ce bloc, pour chaque patient.
132
+ Par défaut `MIN(start_date)` (le premier événement). Autres choix : `MAX(start_date)` (le dernier),
133
+ `MAX(end_date)`, `MIN(end_date)`.
134
+
135
+ **Exemple** : consultations dans l'année qui suit le premier code de diabète.
136
+
137
+ | block_name | block_type | value | date_sql | reference_date_block | reference_date_sql |
138
+ | --- | --- | --- | --- | --- | --- |
139
+ | `diabete` | `CIM10` | `E11` | `start_date <= reference_date` | | |
140
+ | `suivi_1an` | `Consultations` | | `start_date >= reference_date AND start_date <= reference_date + INTERVAL '1 year'` | `diabete` | `MIN(start_date)` |
141
+
142
+ Dans `suivi_1an`, `reference_date` vaut, pour chaque patient, la date de son premier code `E11`.
143
+
144
+ !!! info "Quelles dates sont utilisées ?"
145
+ Seules les dates des événements **retenus** par le bloc référencé sont utilisées : ceux qui ont
146
+ passé son `date_sql`, et uniquement pour les patients qui ont franchi cette étape. Un patient sans
147
+ date dans le bloc référencé n'a pas de date de référence : les filtres temporels l'excluent.
148
+
149
+ ## `supplementary_params` : paramètres spécifiques
150
+
151
+ Certains blocs ont des options propres (ex. `MedecinTraitant` : ne garder que les médecins traitants
152
+ renforcés). Elles s'écrivent sous forme de dictionnaire dans la colonne `supplementary_params` :
153
+
154
+ ```text
155
+ {"mtr_only": false, "include_external": true}
156
+ ```
157
+
158
+ - Les noms disponibles et leurs valeurs par défaut sont dans la fiche du bloc et dans l'onglet
159
+ `🔒 Definitions`.
160
+ - Les vrais/faux s'écrivent `true` / `false` ; les listes `["a", "b"]` ; les textes entre guillemets.
161
+ - La saisie est tolérante (guillemets simples acceptés), mais **un nom de paramètre inconnu
162
+ provoque une erreur** (`Extra inputs are not permitted`).
@@ -0,0 +1,73 @@
1
+ # Requipso
2
+
3
+ **Requipso** est un requêteur de données de santé pour *ipso*: il permet de construire des « pipelines de requêtes » sur la base RED (dossiers patients ipso) via:
4
+
5
+ * Du code Python
6
+ * Directement depuis une feuille Google Sheet.
7
+
8
+ À partir de la description d'une étude dans un Google Sheet, le requêteur produit :
9
+
10
+ - un **diagramme d'inclusion** (flowchart de type CONSORT) qui montre, étape par étape, combien de
11
+ patients sont retenus et combien sont exclus ;
12
+ - un **tableau descriptif** (le classique « Tableau 1 » d'une publication) qui décrit les populations
13
+ d'intérêt : âge, genre, antécédents, traitements, biométrie… ;
14
+ - la **liste des patients** retenus à n'importe quelle étape, exportable en CSV.
15
+
16
+ ![Démonstration de Requipso](assets/demo.gif)
17
+
18
+ ## Comment ça marche, en une image
19
+
20
+ ```mermaid
21
+ flowchart LR
22
+ sheet["Google Sheet<br/>(Projet, Inclusion,<br/>Descriptive_table)"] --> app["Application Requipso<br/>(navigateur)"]
23
+ data[("Données RED<br/>(fichiers parquet)")] --> app
24
+ app --> flow["Flowchart d'inclusion<br/>(Google Drive)"]
25
+ app --> table["Tableau descriptif<br/>(onglet 🔒 Results)"]
26
+ app --> csv["Liste de patients<br/>(CSV)"]
27
+ ```
28
+
29
+ 1. Vous décrivez votre étude dans un Google Sheet en assemblant des **blocs** (par exemple « âge ≥ 18 ans »,
30
+ « a un antécédent de diabète », « a eu au moins une consultation dans l'année »).
31
+ 2. Vous lancez l'application Requipso, choisissez le dossier de données et votre Google Sheet.
32
+ 3. Requipso exécute les blocs, dessine le flowchart, calcule les statistiques et les réécrit dans votre
33
+ Google Sheet.
34
+
35
+ !!! danger "Données"
36
+ Pour l'instant, il est nécessaire de disposer des données *en local sur votre ordinateur*. Il est prévu de pouvoir lancer ce requêteur en local mais sur des données distantes, puis directement sur le datalab Onyxia
37
+
38
+ ## Par où commencer ?
39
+
40
+ <div class="grid cards" markdown>
41
+
42
+ - :material-account: **Je veux construire une étude**
43
+
44
+ ---
45
+
46
+ Le [guide utilisateur](guide/demarrage.md) explique pas à pas comment remplir le Google Sheet et
47
+ lancer l'application. Aucune connaissance technique n'est requise.
48
+
49
+ - :material-puzzle: **Je cherche un bloc précis**
50
+
51
+ ---
52
+
53
+ Le [catalogue des blocs](blocs/index.md) décrit chaque bloc : ce qu'il calcule, les données
54
+ utilisées, ses paramètres et des exemples prêts à copier.
55
+
56
+ - :material-cog: **Je veux contribuer au code**
57
+
58
+ ---
59
+
60
+ La section [fonctionnement interne](technique/architecture.md) décrit l'architecture, le cycle
61
+ d'exécution d'un bloc et explique comment [ajouter un nouveau bloc](technique/ajouter-un-bloc.md).
62
+
63
+ </div>
64
+
65
+ ## Vocabulaire
66
+
67
+ | Terme | Signification |
68
+ | --- | --- |
69
+ | **Bloc** | Brique élémentaire de requête (ex. `Age`, `CIM10`, `Consultations`). Chaque bloc calcule une ou plusieurs valeurs par patient. |
70
+ | **Étape** | Une ligne (ou un groupe de lignes) de l'onglet `Inclusion` ; correspond à une boîte du flowchart. |
71
+ | **Date de référence** | Date à laquelle on « regarde » les patients (ex. l'âge au 01/01/2024). |
72
+ | **Population** | Une étape du flowchart dont les patients forment une colonne du tableau descriptif. |
73
+ | **Événement** | Une donnée datée qui peut apparaître plusieurs fois pour un patient (consultation, prescription, mesure…). |
@@ -0,0 +1,3 @@
1
+ .md-grid {
2
+ max-width: 1600px;
3
+ }