From 72f99520d739138d0458529723807e02ee5aced1 Mon Sep 17 00:00:00 2001 From: Tamara Slosarek Date: Thu, 10 Oct 2024 15:13:42 +0200 Subject: [PATCH] docs(scripts): organize README --- scripts/README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/scripts/README.md b/scripts/README.md index 7b7254e5..4c0c99a3 100644 --- a/scripts/README.md +++ b/scripts/README.md @@ -89,6 +89,14 @@ Run `python run_analysis.py [--correct]` to analyze annotations and optionally correct what can be corrected easily in `_corrected_.base64.json`. +### Drug annotation checks + +| Check | Description | `--correct`ed | Only for single-gene results* | +| ----- | ----------- | ------------- | ----------------------------- | +| `brand_whitespace` | Drug brand names should not have leading or trailing white space. | ✅ | ❌ | + +### Guideline annotation checks + | Check | Description | `--correct`ed | Only for single-gene results* | | ----- | ----------- | ------------- | ----------------------------- | | `has_consult` | Is "consult your pharmacist..." included in recommendation? | ✅ | ❌ | @@ -97,7 +105,6 @@ and optionally correct what can be corrected easily in | `yellow_warning` | Yellow warning level should be present when the red warning level does not apply but the implication contains "may not work" or "side effects" or the recommendation contains non-standard dose. | ❌ | ❌ | | `green_warning` | Green warning level should be applied in all non-red and non-yellow cases and when the recommendation states "at standard dose" or similar formulations. | ❌ | ❌ | | `none_warning` | None warning level should be applied in all not handled warning level cases. | ❌ | ❌ | -| `brand_whitespace` | Drug brand names should not have leading or trailing white space. | ✅ | ❌ | | `metabolization_before_consequence` | Metabolization implications should come before consequences. | ❌ | ❌ | \* Skips guidelines with multiple genes unless all results but one are missing