Merge pull request #3 from Shakeri-Lab/local

Local

Author: aab5zd

README.md

@@ -1,54 +1,52 @@
-# React + TypeScript + Vite
-
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-
-Currently, two official plugins are available:
-
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
-
-## Expanding the ESLint configuration
-
-If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:
-
-```js
-export default tseslint.config({
-  extends: [
-    // Remove ...tseslint.configs.recommended and replace with this
-    ...tseslint.configs.recommendedTypeChecked,
-    // Alternatively, use this for stricter rules
-    ...tseslint.configs.strictTypeChecked,
-    // Optionally, add this for stylistic rules
-    ...tseslint.configs.stylisticTypeChecked,
-  ],
-  languageOptions: {
-    // other options...
-    parserOptions: {
-      project: ['./tsconfig.node.json', './tsconfig.app.json'],
-      tsconfigRootDir: import.meta.dirname,
-    },
-  },
-})
-```
-
-You can also install [eslint-plugin-react-x](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-x) and [eslint-plugin-react-dom](https://github.com/Rel1cx/eslint-react/tree/main/packages/plugins/eslint-plugin-react-dom) for React-specific lint rules:
-
-```js
-// eslint.config.js
-import reactX from 'eslint-plugin-react-x'
-import reactDom from 'eslint-plugin-react-dom'
-
-export default tseslint.config({
-  plugins: {
-    // Add the react-x and react-dom plugins
-    'react-x': reactX,
-    'react-dom': reactDom,
-  },
-  rules: {
-    // other rules...
-    // Enable its recommended typescript rules
-    ...reactX.configs['recommended-typescript'].rules,
-    ...reactDom.configs.recommended.rules,
-  },
-})
-```
+# How to Use the Diagnosis Grouping Tool
+
+**Goal:** This tool is designed to help clinicians organize and group patient diagnoses based on clinical similarity and causal relationships. The goal is to create meaningful clusters of diagnoses that reflect underlying conditions or disease progression pathways.
+
+---
+
+**1. Getting Started**
+
+* **Enter Computing ID:** Use your unique ID to start or resume your work. Use the same ID each time to load your saved progress.
+* **Click "Start / Load Session":** This loads your saved groups and the list of diagnoses to sort.
+
+**2. The Screen**
+
+* **Left Side (Suggestions / Unsorted):** Shows diagnoses that need grouping. Initially, these are suggestions. Later, it will show diagnoses from any groups you delete. A counter shows your progress through the initial suggestions (e.g., `(1 / 15)`).
+* **Right Side (Your Confirmed Groups):** Shows the groups and subgroups you create. Groups are listed alphabetically.
+
+**3. Grouping Diagnoses**
+
+* **Your Task:** Move all diagnoses from the left side into groups on the right side.
+* **Handling Suggestions (Left Side):**
+    * **Option 1: Group Them Together:** If the suggested diagnoses belong together, click **"Create / Merge Group"**.
+        * Enter a name. If it's a *new* name, a new group is made. If it's an *existing* group name, the diagnoses are added to that group.
+    * **Option 2: Drag and Drop:** If the suggestions don't belong together, **drag** each diagnosis individually from the left side and **drop** it onto a group header on the right side.
+* **Creating Empty Groups (Right Side):**
+    * Click **"+ Create New Group"** at the bottom right.
+    * Type a unique name and click "Add Group".
+    * Drag diagnoses into this new group.
+* **Creating Subgroups (Right Side):**
+    * **Purpose:** Use subgroups for diagnoses that are *directly caused* by another (e.g., Glaucoma caused by Diabetes). The main condition is the parent group.
+    * **How:** Click **"+ Add Subgroup"** within the parent group. Name the subgroup (e.g., "Glaucoma").
+* **Ordering Subgroups:**
+    * **Purpose:** Show disease progression if a group has multiple causal subgroups.
+    * **How:** **Drag and drop** the subgroup headers up or down within their parent group.
+* **Deleting Groups/Subgroups:**
+    * Hover over the group/subgroup name on the right.
+    * Click the **trash can icon** that appears.
+    * Confirm the deletion.
+    * **What happens:** The group is removed, but the diagnoses inside it are moved to the "Deleted / Unsorted Diagnoses" list on the left side for you to regroup later.
+* **Handling Deleted/Unsorted Diagnoses (Left Side):**
+    * After finishing the initial suggestions, any diagnoses from deleted groups appear here.
+    * You **must drag** these into groups on the right side until this list is empty.
+
+**4. Saving & Undo**
+
+* **Saving:** Your work saves automatically, but you can click **"Save Progress"** to save immediately.
+* **Undo:** Click **"Undo"** to reverse your last action (like adding/deleting a group or moving a diagnosis).
+
+**5. Grouping Ideas**
+
+* **Main Groups:** Put diagnoses describing the same condition together (e.g., group "Glaucoma - Left Eye" and "Glaucoma - Right Eye" into a "Glaucoma" group).
+* **Subgroups:** Show cause-and-effect (e.g., "Diabetes" group with a "Diabetic Retinopathy" subgroup). Order subgroups by progression.
+* **Goal:** Make sure every diagnosis ends up in a group.