diagcalc 3.2.0 → 3.2.1
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.
- package/README.md +39 -0
- package/package.json +9 -1
package/README.md
CHANGED
|
@@ -10,6 +10,35 @@ Both interfaces use the same calculation engine.
|
|
|
10
10
|
## Repository
|
|
11
11
|
|
|
12
12
|
- GitHub: `https://github.com/tiagojct/diagcalc`
|
|
13
|
+
- Web app: `https://tiagojct.github.io/diagcalc/`
|
|
14
|
+
- npm package: `https://www.npmjs.com/package/diagcalc`
|
|
15
|
+
|
|
16
|
+
## Description
|
|
17
|
+
|
|
18
|
+
DIAGCALC is designed for a simple job: start from a confusion matrix, calculate the main diagnostic test measures, and show how the test result changes the probability of disease.
|
|
19
|
+
|
|
20
|
+
It is built for teaching, self-study, and quick practical use. The web app is useful in the classroom and in browser-based demonstrations. The terminal app is useful for keyboard-driven work, SSH sessions, scripting, and lightweight environments.
|
|
21
|
+
|
|
22
|
+
## Operating Model
|
|
23
|
+
|
|
24
|
+
The app follows the same sequence used in many teaching sessions on diagnostic reasoning:
|
|
25
|
+
|
|
26
|
+
1. define the case or load a reference scenario
|
|
27
|
+
2. inspect the confusion matrix
|
|
28
|
+
3. estimate the pre-test probability
|
|
29
|
+
4. calculate core performance measures
|
|
30
|
+
5. interpret LR+ and LR-
|
|
31
|
+
6. update to post-test probability
|
|
32
|
+
|
|
33
|
+
The web and terminal interfaces both follow that workflow.
|
|
34
|
+
|
|
35
|
+
## Philosophy
|
|
36
|
+
|
|
37
|
+
- keep the calculator simple enough to use during teaching
|
|
38
|
+
- keep the maths explicit and easy to verify
|
|
39
|
+
- keep the interfaces lightweight and dependency-light
|
|
40
|
+
- keep the same results across web, TUI, and CLI
|
|
41
|
+
- support both interactive learning and automation
|
|
13
42
|
|
|
14
43
|
## Features
|
|
15
44
|
|
|
@@ -27,6 +56,8 @@ Both interfaces use the same calculation engine.
|
|
|
27
56
|
|
|
28
57
|
The web app is static. It does not need a build step.
|
|
29
58
|
|
|
59
|
+
It is intended for teaching sessions, demonstrations, and direct interactive exploration.
|
|
60
|
+
|
|
30
61
|
### Run locally
|
|
31
62
|
|
|
32
63
|
Open `index.html` directly in a browser, or serve the folder locally:
|
|
@@ -53,6 +84,8 @@ http://localhost:8080
|
|
|
53
84
|
|
|
54
85
|
The terminal app requires Node.js 18 or newer.
|
|
55
86
|
|
|
87
|
+
It is intended for keyboard-first use, quick calculations, reproducible terminal workflows, and scripting.
|
|
88
|
+
|
|
56
89
|
### Install locally
|
|
57
90
|
|
|
58
91
|
```bash
|
|
@@ -98,6 +131,8 @@ Get JSON output:
|
|
|
98
131
|
diag --dataset ddimer --format json
|
|
99
132
|
```
|
|
100
133
|
|
|
134
|
+
The CLI is useful when you want a one-shot calculation or when you want to integrate the calculator into scripts or other tooling.
|
|
135
|
+
|
|
101
136
|
### TUI controls
|
|
102
137
|
|
|
103
138
|
- `Tab` / `Ctrl-N`: next panel
|
|
@@ -144,6 +179,10 @@ npm install -g diagcalc
|
|
|
144
179
|
diag --tui
|
|
145
180
|
```
|
|
146
181
|
|
|
182
|
+
Package page:
|
|
183
|
+
|
|
184
|
+
- `https://www.npmjs.com/package/diagcalc`
|
|
185
|
+
|
|
147
186
|
## Project Structure
|
|
148
187
|
|
|
149
188
|
- `index.html` - web app markup
|
package/package.json
CHANGED
|
@@ -1,7 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "diagcalc",
|
|
3
|
-
"version": "3.2.
|
|
3
|
+
"version": "3.2.1",
|
|
4
4
|
"description": "Diagnostic calculator for the browser, terminal, and plain CLI.",
|
|
5
|
+
"homepage": "https://tiagojct.github.io/diagcalc/",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/tiagojct/diagcalc.git"
|
|
9
|
+
},
|
|
10
|
+
"bugs": {
|
|
11
|
+
"url": "https://github.com/tiagojct/diagcalc/issues"
|
|
12
|
+
},
|
|
5
13
|
"license": "MIT",
|
|
6
14
|
"keywords": [
|
|
7
15
|
"diagnostics",
|