admin/HighCostDrugsDemo
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
e8145867c1d1be23ff1ae8d9753980943eafc121
HighCostDrugsDemo/IMPLEMENTATION_PLAN.md
T

18 KiB
Raw Blame History

Implementation Plan — Reflex → Dash Migration

Project Overview

Migrate the Reflex web application to Dash (Plotly) + Dash Mantine Components. The backend (src/) is untouched — only the frontend changes.

What Changes

  • pathways_app/ (Reflex) → dash_app/ (Dash + DMC)
  • run_dash.py entry point replaces reflex run
  • CSS extracted from 01_nhs_classic.html → dash_app/assets/nhs.css
  • Drug/Directory/Indication filters consolidated into a right-side dmc.Drawer

What Stays (DO NOT MODIFY pipeline/analysis logic)

  • data_processing/pathway_pipeline.py, transforms.py, diagnosis_lookup.py (matching logic)
  • analysis/pathway_analyzer.py, statistics.py
  • cli/refresh_pathways.py
  • data_processing/schema.py, reference_data.py, cache.py, data_source.py
  • SQLite schema and pathway_nodes table
  • data/ reference files (CSVs, pathways.db)

What CAN be edited in src/ (shared utilities)

  • visualization/plotly_generator.py — add/refactor a function to accept list-of-dicts (what Dash produces) instead of only DataFrames
  • data_processing/database.py — add shared query functions for pathway node loading so both Reflex and Dash use the same queries
  • core/config.py — if path resolution needs adjusting

Dash App Structure

dash_app/
├── __init__.py
├── app.py                    # Entry point, layout root, dcc.Store components
├── assets/
│   └── nhs.css               # Extracted from 01_nhs_classic.html
├── data/
│   ├── queries.py             # SQLite queries (extracted from Reflex AppState)
│   └── card_browser.py        # DimSearchTerm.csv → directorate tree
├── components/
│   ├── header.py              # Top header bar
│   ├── sidebar.py             # Left navigation
│   ├── kpi_row.py             # 4 KPI cards
│   ├── filter_bar.py          # Chart type toggle + date dropdowns
│   ├── chart_card.py          # Chart area with tabs + dcc.Graph
│   ├── drawer.py              # dmc.Drawer with card browser
│   └── footer.py              # Page footer
├── callbacks/
│   ├── __init__.py            # register_callbacks(app)
│   ├── filters.py             # Date/chart-type → app-state store
│   ├── chart.py               # chart-data → go.Icicle figure
│   ├── drawer.py              # Drawer open/close + drug selection
│   └── kpi.py                 # chart-data → KPI card values
└── utils/
    └── formatting.py          # Cost/patient display formatters

State Management (3 dcc.Store components)

  • app-state (session): chart_type, initiated, last_seen, selected_drugs, selected_directorates, date_filter_id
  • chart-data (memory): nodes[], unique_patients, total_drugs, total_cost
  • reference-data (session): available_drugs, directorate_tree (loaded once)

Callback Chain

Page Load → load_reference_data → reference-data store
         → load_pathway_data → chart-data store
                              ├→ update_kpis → KPI cards
                              └→ update_chart → dcc.Graph

Filter change → update_app_state → app-state store → load_pathway_data → (chain above)

Drawer selection → update_drug_selection → app-state store → load_pathway_data → (chain above)

Directorate Card Browser (dmc.Drawer)

  • Position: right, ~480px wide
  • Top card: "All Drugs" — flat list from pathway_nodes level 3. Pick one drug → see it across all directorates/indications.
  • Below: Cards per PrimaryDirectorate (from DimSearchTerm.csv). Each has dmc.Accordion with indication items → drug chips inside.
  • Clear Filters button resets all selections.
  • Data model: DimSearchTerm.csv grouped by PrimaryDirectorate → Search_Term → CleanedDrugName

Phase 0: Project Scaffolding

0.1 Create dash_app/ skeleton + update pyproject.toml

  • Create dash_app/ directory with __init__.py, app.py, subdirectories (assets/, data/, components/, callbacks/, utils/)
  • Create run_dash.py at project root (simple from dash_app.app import app; app.run(debug=True, port=8050))
  • Update pyproject.toml: add dash>=2.14.0, dash-mantine-components>=0.14.0 to dependencies (keep reflex temporarily)
  • Create minimal app.py with dash.Dash(__name__), DMC provider wrapper, and "Hello Dash" placeholder layout
  • Checkpoint: python run_dash.py starts, shows "Hello Dash" at localhost:8050 ✓

0.2 Extract CSS from 01_nhs_classic.html into dash_app/assets/nhs.css

  • Copy the <style> block from 01_nhs_classic.html (lines 8-314) into dash_app/assets/nhs.css
  • Add Google Fonts @import for Source Sans 3 at top of CSS file
  • Remove the mock icicle chart CSS (.icicle, .icicle__row, .icicle__cell, .lvl-* classes) — Plotly handles the real chart
  • Verify CSS loads by checking browser dev tools when app starts
  • Checkpoint: python run_dash.py loads CSS (check font renders as Source Sans 3) ✓

Phase 1: Data Access Layer

1.1 Create shared data access functions

  • Add query functions to src/data_processing/pathway_queries.py:
    • load_initial_data(db_path) -> dict — extracted from AppState.load_data() (pathways_app.py lines 407-488): returns {"available_drugs": [...], "available_directorates": [...], "available_indications": [...], "total_records": int, "last_updated": str}
    • load_pathway_nodes(db_path, filter_id, chart_type, selected_drugs=None, selected_directorates=None) -> dict — extracted from AppState.load_pathway_data() (lines 490-642): returns {"nodes": [...], "unique_patients": int, "total_drugs": int, "total_cost": float, "last_updated": str}
    • These are plain Python functions that accept db_path as a parameter (no Reflex state objects)
  • Create thin dash_app/data/queries.py that imports and calls the shared functions with the correct db_path
  • Return plain dicts/lists — JSON-serializable for dcc.Store
  • Checkpoint: python -c "from dash_app.data.queries import load_initial_data; print(load_initial_data())" returns valid data

1.2 Build directorate card tree from DimSearchTerm.csv

  • Create dash_app/data/card_browser.py with:
    • build_directorate_tree() → dict structured as {PrimaryDirectorate: {Search_Term: [drug_fragment, ...]}}
    • Loads data/DimSearchTerm.csv, groups by PrimaryDirectorate → Search_Term → split CleanedDrugName by pipe
    • Applies SEARCH_TERM_MERGE_MAP from data_processing.diagnosis_lookup (merge asthma variants)
    • get_all_drugs() → sorted flat list of all unique drug labels from pathway_nodes level 3
  • Checkpoint: python -c "from dash_app.data.card_browser import build_directorate_tree; import json; print(json.dumps(build_directorate_tree(), indent=2))" returns valid tree ✓

Phase 2: Static Layout

2.1 Header + sidebar components

  • Create dash_app/components/header.py — make_header() function returning Dash HTML component
    • NHS logo, title "HCD Analysis", breadcrumb, data freshness indicator (status dot + record count + last updated)
    • Use CSS classes from nhs.css: .top-header, .top-header__brand, .top-header__logo, .top-header__title, etc.
    • Record count and last updated are html.Span with IDs for callback updates: id="header-record-count", id="header-last-updated"
  • Create dash_app/components/sidebar.py — make_sidebar() function
    • Navigation items matching 01_nhs_classic.html sidebar (Pathway Overview active, Drug Selection, Trust Selection, Directory Selection, Indications, Cost Analysis, Export Data)
    • SVG icons via data URI img elements (Dash doesn't support inline SVGs natively)
    • "Drug Selection" (id="sidebar-drug-selection") and "Indications" (id="sidebar-indications") items have IDs for drawer callbacks (Phase 4)
    • Footer: "NHS Norfolk & Waveney ICB / High Cost Drugs Programme"
  • Checkpoint: Components render in browser with correct NHS styling ✓

2.2 Main content area: KPI row + filter bar + chart card

  • Create dash_app/components/kpi_row.py — make_kpi_row() function
    • 4 KPI cards: Unique Patients, Drug Types, Total Cost, Indication Match Rate
    • Each card value has an ID for callback updates: id="kpi-patients", id="kpi-drugs", id="kpi-cost", id="kpi-match"
    • CSS classes: .kpi-row, .kpi-card, .kpi-card__label, .kpi-card__value, .kpi-card__sub
  • Create dash_app/components/filter_bar.py — make_filter_bar() function
    • Chart type toggle pills ("By Directory" / "By Indication") — use html.Button with .toggle-pill CSS
    • Initiated dropdown: All years, Last 2 years, Last 1 year — use dcc.Dropdown or html.Select with .filter-select
    • Last seen dropdown: Last 6 months, Last 12 months
    • NO drug/directorate dropdowns here (those are in the drawer)
    • Component IDs: id="chart-type-directory", id="chart-type-indication", id="filter-initiated", id="filter-last-seen"
  • Create dash_app/components/chart_card.py — make_chart_card() function
    • Card header with title + dynamic subtitle (hierarchy label: "Trust → Directorate → Drug → Pathway")
    • Tab row: Icicle (active), Sankey (disabled placeholder), Timeline (disabled placeholder)
    • dcc.Graph(id="pathway-chart") filling the card body
    • CSS classes: .chart-card, .chart-card__header, .chart-card__tabs, .chart-tab
  • Checkpoint: All three components render with correct layout and styling

2.3 Footer + full page assembly

  • Create dash_app/components/footer.py — make_footer() function
    • CSS class .page-footer, same text as 01_nhs_classic.html
  • Update dash_app/app.py to assemble full page layout:
    • dmc.MantineProvider(children=[header, sidebar, main_content])
    • Main content: KPI row → filter bar → chart card → footer
    • Add 3 dcc.Store components: id="app-state", id="chart-data", id="reference-data"
    • Wrap main content in html.Main(className="main")
  • Checkpoint: Full page renders at localhost:8050, layout matches 01_nhs_classic.html visually

Phase 3: Core Callbacks

3.1 Reference data loading + filter state management

  • Create dash_app/callbacks/filters.py:
    • load_reference_data callback: fires on page load, calls queries.load_initial_data(), populates reference-data store + header indicators
    • update_app_state callback: fires when chart-type toggle or date dropdowns change, computes date_filter_id (e.g., "all_6mo"), updates app-state store
    • Chart type toggle: use callback_context to determine which button was clicked, set active class via className
  • Create dash_app/callbacks/__init__.py with register_callbacks(app) that imports and registers all callback modules
  • Wire register_callbacks(app) in app.py
  • Checkpoint: Page loads reference data, filter dropdowns update app-state store (verify via browser dev tools → dcc.Store)

3.2 Pathway data loading callback

  • Create dash_app/callbacks/chart.py (or add to filters.py):
    • load_pathway_data callback: Input=app-state store, Output=chart-data store
    • Calls queries.load_pathway_data(filter_id, chart_type, selected_drugs, selected_directorates)
    • Runs on page load AND whenever app-state changes
  • Checkpoint: Changing date filter updates chart-data store with new pathway nodes ✓

3.3 KPI update callback

  • Create dash_app/callbacks/kpi.py:
    • update_kpis callback: Input=chart-data store, Output=KPI card values (4 outputs)
    • Extracts unique_patients, total_drugs, total_cost from chart-data
    • Formats numbers: patients with commas, cost as "£XXX.XM", drugs as plain number
  • Checkpoint: KPIs update when date filters change

3.4 Icicle chart rendering callback

  • Add a create_icicle_from_nodes(nodes: list[dict], title: str) -> go.Figure function to src/visualization/plotly_generator.py:
    • Accepts list-of-dicts (the format stored in chart-data dcc.Store / returned by load_pathway_data)
    • Same 10-field customdata, colorscale, texttemplate, hovertemplate as the existing Reflex icicle_figure (pathways_app.py lines 769-920)
    • The existing create_icicle_figure(ice_df) stays untouched — the new function is an additional entry point for dict-based data
    • Use the NHS blue gradient colorscale from the Reflex version: [[0.0, "#003087"], [0.25, "#0066CC"], ...]
  • Add to dash_app/callbacks/chart.py:
    • update_chart callback: Input=chart-data store, Output=pathway-chart figure
    • Calls create_icicle_from_nodes(chart_data["nodes"], title) from the shared visualization module
    • Dynamic title based on chart type and filters
  • Checkpoint: Real icicle chart renders with SQLite data, filters change the chart, hover shows full statistics

Phase 4: Directorate Card Browser

4.1 dmc.Drawer layout

  • Create dash_app/components/drawer.py — make_drawer() function:
    • dmc.Drawer(id="drug-drawer", position="right", size="480px")
    • Top section: "All Drugs" card — flat alphabetical list of all drug names from pathway_nodes level 3
      • Each drug as a dmc.Chip or clickable badge, ID pattern: {"type": "drug-chip", "index": drug_name}
    • Below: One dmc.Card per PrimaryDirectorate from DimSearchTerm.csv
      • Card title = PrimaryDirectorate name
      • Inside: dmc.Accordion with one item per Search_Term (indication)
      • Inside each accordion item: drug fragment chips
    • Bottom: dmc.Button("Clear Filters", id="clear-drug-filters") — full width
  • Checkpoint: Drawer opens with correct layout, all directorates and drugs visible

4.2 Drawer callbacks

  • Create dash_app/callbacks/drawer.py:
    • Open/close drawer: sidebar "Drug Selection" or "Indications" click → open drawer
    • Drug selection: ChipGroup value change → app-state.selected_drugs via update_app_state
    • Drug fragment click: pattern-matching badge clicks → substring match → update chip selection
    • Clear filters: resets chip selection → app-state.selected_drugs empties
    • Fragment matching uses drug.upper() in fragment.upper() for substring match
    • Toggle behavior: clicking already-selected fragment deselects matching drugs
  • Checkpoint: Select drug from drawer → chart filters to show that drug → clear resets

Phase 5: Polish & Cleanup

5.1 Trust selection

  • Add trust selection either:
    • In the dmc.Drawer as a "Trusts" section (preferred — keeps all filters in one place), OR
    • As sidebar checkboxes
  • Wire trust selection to selected_trusts in app-state → pathway data reload
  • Checkpoint: Selecting trusts filters the chart correctly

5.2 Loading/error/empty states + dynamic hierarchy label

  • Add dcc.Loading wrapper around chart area
  • Show "No data" message when chart-data is empty
  • Show error toast/alert when database query fails
  • Dynamic chart subtitle: "Trust → Directorate → Drug → Pathway" or "Trust → Indication → Drug → Pathway" based on chart type
  • Checkpoint: Loading spinner appears during data fetch, empty state shows message

5.3 Data freshness indicator

  • Header shows: green dot + "{N} records" + "Last updated: {relative_time}"
  • Pull from pathway_refresh_log via queries.load_initial_data()
  • Format as relative time (e.g., "2h ago", "yesterday")
  • Checkpoint: Header shows correct data freshness

5.4 Remove Reflex + final validation

  • Remove reflex from pyproject.toml dependencies
  • Delete or archive pathways_app/ directory (move to archive/)
  • Delete pathways_app/styles.py and any Reflex-specific files
  • Update project CLAUDE.md to document Dash app structure, new run command, callback architecture
  • Verify: python run_dash.py starts cleanly, full end-to-end workflow works
  • Verify: No Reflex imports anywhere in dash_app/
  • Checkpoint: Full application works, no Reflex remnants, CLAUDE.md updated

Completion Criteria

All tasks marked [x] AND:

  • python run_dash.py starts cleanly at localhost:8050
  • Layout matches 01_nhs_classic.html (header, sidebar, KPIs, filter bar, chart card, footer)
  • Icicle chart renders with real SQLite data (pathway_nodes)
  • Date filters + chart type toggle update chart correctly
  • dmc.Drawer opens, shows directorate cards with indications/drugs
  • Selecting a drug from drawer filters the chart
  • "All Drugs" card allows selecting any drug across all contexts
  • "Clear Filters" resets all selections
  • KPIs update dynamically (patients, drugs, cost)
  • No Reflex imports in dash_app/

Key Reference Files

File Purpose
01_nhs_classic.html Design reference — CSS classes, layout structure, visual targets
pathways_app/pathways_app.py Source of truth for data loading logic (lines 407-642) and icicle chart (lines 769-920)
data/pathways.db SQLite database with pre-computed pathway_nodes
data/DimSearchTerm.csv Directorate → Search_Term → drug mapping for card browser
src/data_processing/diagnosis_lookup.py SEARCH_TERM_MERGE_MAP constant for asthma normalization

Key Data Patterns

Date Filter IDs

ID Initiated Last Seen
all_6mo All years Last 6 months (DEFAULT)
all_12mo All years Last 12 months
1yr_6mo Last 1 year Last 6 months
1yr_12mo Last 1 year Last 12 months
2yr_6mo Last 2 years Last 6 months
2yr_12mo Last 2 years Last 12 months

Pathway Node Columns (from SQLite)

parents, ids, labels, level, value, cost, costpp, cost_pp_pa, colour, first_seen, last_seen, first_seen_parent, last_seen_parent, average_spacing, average_administered, avg_days, trust_name, directory, drug_sequence, chart_type, date_filter_id

Icicle Chart Customdata (10 fields)

[0] value          — patient count
[1] colour         — proportion of parent
[2] cost           — total cost
[3] costpp         — cost per patient
[4] first_seen     — first intervention date
[5] last_seen      — last intervention date
[6] first_seen_parent  — earliest date in parent group
[7] last_seen_parent   — latest date in parent group
[8] average_spacing    — dosing information string
[9] cost_pp_pa         — cost per patient per annum
Reference in New Issue View Git Blame Copy Permalink