Commit 5dddb6a7 authored by Pierre Dittgen's avatar Pierre Dittgen
Browse files

Update README.md

parent 0c215523
# Validata-Badge
Validata badge configuration
\ No newline at end of file
## Configuration
La configuration du badge Validata est contenue dans le fichier badge_conf.toml. Ex:
```toml
[body]
# Seuil d'acceptabilité (entre 0 et 1.0)
acceptability-threshold = 0.3
# Poids associé à chaque type d'erreur (entre 0 et 1.0)
# Par défaut, le poids associé est 1.0 (100%).
# Un type d'erreur peut être ignoré en positionnant le poids à 0 (non recommandé)
[body.errors-weight]
# Erreur: la valeur ne respecte pas l'expression régulière donnée
pattern-constraint = 0.5
# Erreur: la taille de la valeur dépasse la limite autorisée
maximum-length-constraint: 0.2
```
Elle indique le seuil (`acceptability-threshold`) au delà duquel le ratio
d'erreur de contenu passe de l'orange (acceptable ?) au rouge.
Chaque type d'erreur intervenant dans le calcul du taux d'erreur peut être
pondéré individuellement (`errors-weight`).
## Badge
La construction d'un badge nécessite de croiser les résultats de validation
d'une ressource et les informations de configuration du badge.
Un badge est constitué des informations suivantes :
- structure : les valeurs possibles sont `OK`, `WARN` et `KO`
- `OK`: pas d'erreur de structure
- `WARN`: erreur(s) de structure récupérable(s)
- `KO`: erreur(s) de structure non récupérable(s)
- body: Les valeurs possibles sont `OK`, `WARN` et `KO`
- `OK`: pas d'erreur de contenu
- `WARN`: pourcentage d'erreur (`R`) inférieur au seuil d'acceptabilité (`Th`)
- `KO`: pourcentage d'erreur (`R`) supérieur ou égal au seuil d'acceptabilité (`Th`)
- ratio (`R`) : pourcentage d'erreur (valeurs comprises entre 0 et 1)
Notes :
- Si la propriété `structure` vaut `KO`, les informations de `body` et `ratio`
ne sont pas données.
- `R` = taux d'erreur (Error Ratio) calculé comme le nombre de cellules en erreur sur le nombre de cellules total (valeur comprise entre 0 et 1)
pondéré par le poids sur le type d'erreur. Le poids associé à chaque type d'erreur est spécifié dans la configuration
- `Th` = seuil d'acceptabilité (Acceptability Threshold) à partir duquel le témoin passe de l'orange au rouge (valeur comprise entre 0 et 1).
La valeur du seuil est spécifié dans la configuration.
## Représentation graphique du badge
Le badge est en 2 parties :
- partie gauche : bloc gris foncé avec le libellé "Validata"
- partie droite : bloc vert, orange ou rouge contenant du texte (cf. tableau ci-dessous)
| Structure | Contenu | Texte à afficher | Couleur |
|-----------|----------|---------------------------|---------|
| KO | * | "structure invalide" | rouge |
| WARN | KO | "cellules valides : `P`%" | rouge |
| WARN | WARN | "cellules valides : `P`%" | orange |
| WARN | OK | "structure invalide" | orange |
| OK | KO | "cellules valides : `P`%" | rouge |
| OK | WARN | "cellules valides : `P`%" | orange |
| OK | OK | "valide" | vert |
`P` = pourcentage de qualité calculé comme : `(1 - R) * 100`
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment