psytools 0.6.2 → 0.6.4
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/LICENSE +8 -5
- package/README.md +24 -7
- package/SOURCES.md +165 -3
- package/dist/cjs/inventories/cbi.d.ts +31 -0
- package/dist/cjs/inventories/cbi.js +122 -0
- package/dist/cjs/inventories/csi16.d.ts +10 -0
- package/dist/cjs/inventories/csi16.js +160 -0
- package/dist/cjs/inventories/eat26.d.ts +12 -0
- package/dist/cjs/inventories/eat26.js +111 -0
- package/dist/cjs/inventories/gds15.d.ts +11 -0
- package/dist/cjs/inventories/gds15.js +81 -0
- package/dist/cjs/inventories/index.d.ts +14 -1
- package/dist/cjs/inventories/index.js +34 -1
- package/dist/cjs/inventories/pc-ptsd-5.d.ts +12 -0
- package/dist/cjs/inventories/pc-ptsd-5.js +91 -0
- package/dist/cjs/inventories/pcl5.d.ts +10 -0
- package/dist/cjs/inventories/pcl5.js +124 -0
- package/dist/cjs/inventories/phq15.d.ts +10 -0
- package/dist/cjs/inventories/phq15.js +74 -0
- package/dist/cjs/inventories/phq4.d.ts +11 -0
- package/dist/cjs/inventories/phq4.js +73 -0
- package/dist/cjs/inventories/phq8.d.ts +11 -0
- package/dist/cjs/inventories/phq8.js +71 -0
- package/dist/cjs/inventories/tipi.d.ts +10 -0
- package/dist/cjs/inventories/tipi.js +70 -0
- package/dist/cjs/inventories/ucla-ls3.d.ts +10 -0
- package/dist/cjs/inventories/ucla-ls3.js +127 -0
- package/dist/cjs/locales/de/cbi.d.ts +7 -0
- package/dist/cjs/locales/de/cbi.js +110 -0
- package/dist/cjs/locales/de/csi16.d.ts +3 -0
- package/dist/cjs/locales/de/csi16.js +61 -0
- package/dist/cjs/locales/de/eat26.d.ts +3 -0
- package/dist/cjs/locales/de/eat26.js +47 -0
- package/dist/cjs/locales/de/gds15.d.ts +4 -0
- package/dist/cjs/locales/de/gds15.js +34 -0
- package/dist/cjs/locales/de/pc-ptsd-5.d.ts +4 -0
- package/dist/cjs/locales/de/pc-ptsd-5.js +32 -0
- package/dist/cjs/locales/de/pcl5.d.ts +4 -0
- package/dist/cjs/locales/de/pcl5.js +48 -0
- package/dist/cjs/locales/de/phq15.d.ts +4 -0
- package/dist/cjs/locales/de/phq15.js +35 -0
- package/dist/cjs/locales/de/phq4.d.ts +4 -0
- package/dist/cjs/locales/de/phq4.js +35 -0
- package/dist/cjs/locales/de/phq8.d.ts +4 -0
- package/dist/cjs/locales/de/phq8.js +35 -0
- package/dist/cjs/locales/de/tipi.d.ts +4 -0
- package/dist/cjs/locales/de/tipi.js +39 -0
- package/dist/cjs/locales/de/ucla-ls3.d.ts +4 -0
- package/dist/cjs/locales/de/ucla-ls3.js +48 -0
- package/dist/cjs/locales/es/cbi.d.ts +7 -0
- package/dist/cjs/locales/es/cbi.js +110 -0
- package/dist/cjs/locales/es/csi16.d.ts +3 -0
- package/dist/cjs/locales/es/csi16.js +68 -0
- package/dist/cjs/locales/es/eat26.d.ts +3 -0
- package/dist/cjs/locales/es/eat26.js +47 -0
- package/dist/cjs/locales/es/gds15.d.ts +4 -0
- package/dist/cjs/locales/es/gds15.js +34 -0
- package/dist/cjs/locales/es/pc-ptsd-5.d.ts +4 -0
- package/dist/cjs/locales/es/pc-ptsd-5.js +32 -0
- package/dist/cjs/locales/es/pcl5.d.ts +4 -0
- package/dist/cjs/locales/es/pcl5.js +48 -0
- package/dist/cjs/locales/es/phq15.d.ts +4 -0
- package/dist/cjs/locales/es/phq15.js +35 -0
- package/dist/cjs/locales/es/phq4.d.ts +4 -0
- package/dist/cjs/locales/es/phq4.js +35 -0
- package/dist/cjs/locales/es/phq8.d.ts +4 -0
- package/dist/cjs/locales/es/phq8.js +35 -0
- package/dist/cjs/locales/es/tipi.d.ts +4 -0
- package/dist/cjs/locales/es/tipi.js +39 -0
- package/dist/cjs/locales/es/ucla-ls3.d.ts +4 -0
- package/dist/cjs/locales/es/ucla-ls3.js +44 -0
- package/dist/cjs/locales/index.js +66 -0
- package/dist/cjs/locales/tr/cbi.d.ts +8 -0
- package/dist/cjs/locales/tr/cbi.js +111 -0
- package/dist/cjs/locales/tr/csi16.d.ts +3 -0
- package/dist/cjs/locales/tr/csi16.js +68 -0
- package/dist/cjs/locales/tr/eat26.d.ts +3 -0
- package/dist/cjs/locales/tr/eat26.js +47 -0
- package/dist/cjs/locales/tr/gds15.d.ts +4 -0
- package/dist/cjs/locales/tr/gds15.js +34 -0
- package/dist/cjs/locales/tr/pc-ptsd-5.d.ts +4 -0
- package/dist/cjs/locales/tr/pc-ptsd-5.js +32 -0
- package/dist/cjs/locales/tr/pcl5.d.ts +4 -0
- package/dist/cjs/locales/tr/pcl5.js +48 -0
- package/dist/cjs/locales/tr/phq15.d.ts +4 -0
- package/dist/cjs/locales/tr/phq15.js +35 -0
- package/dist/cjs/locales/tr/phq4.d.ts +4 -0
- package/dist/cjs/locales/tr/phq4.js +35 -0
- package/dist/cjs/locales/tr/phq8.d.ts +4 -0
- package/dist/cjs/locales/tr/phq8.js +33 -0
- package/dist/cjs/locales/tr/tipi.d.ts +4 -0
- package/dist/cjs/locales/tr/tipi.js +39 -0
- package/dist/cjs/locales/tr/ucla-ls3.d.ts +4 -0
- package/dist/cjs/locales/tr/ucla-ls3.js +44 -0
- package/dist/cjs/locales/zh/cbi.d.ts +7 -0
- package/dist/cjs/locales/zh/cbi.js +110 -0
- package/dist/cjs/locales/zh/csi16.d.ts +3 -0
- package/dist/cjs/locales/zh/csi16.js +46 -0
- package/dist/cjs/locales/zh/eat26.d.ts +3 -0
- package/dist/cjs/locales/zh/eat26.js +45 -0
- package/dist/cjs/locales/zh/gds15.d.ts +4 -0
- package/dist/cjs/locales/zh/gds15.js +34 -0
- package/dist/cjs/locales/zh/pc-ptsd-5.d.ts +4 -0
- package/dist/cjs/locales/zh/pc-ptsd-5.js +32 -0
- package/dist/cjs/locales/zh/pcl5.d.ts +4 -0
- package/dist/cjs/locales/zh/pcl5.js +44 -0
- package/dist/cjs/locales/zh/phq15.d.ts +4 -0
- package/dist/cjs/locales/zh/phq15.js +35 -0
- package/dist/cjs/locales/zh/phq4.d.ts +4 -0
- package/dist/cjs/locales/zh/phq4.js +35 -0
- package/dist/cjs/locales/zh/phq8.d.ts +4 -0
- package/dist/cjs/locales/zh/phq8.js +31 -0
- package/dist/cjs/locales/zh/tipi.d.ts +4 -0
- package/dist/cjs/locales/zh/tipi.js +31 -0
- package/dist/cjs/locales/zh/ucla-ls3.d.ts +4 -0
- package/dist/cjs/locales/zh/ucla-ls3.js +34 -0
- package/dist/cjs/types.d.ts +10 -2
- package/dist/esm/inventories/cbi.d.ts +31 -0
- package/dist/esm/inventories/cbi.js +119 -0
- package/dist/esm/inventories/csi16.d.ts +10 -0
- package/dist/esm/inventories/csi16.js +157 -0
- package/dist/esm/inventories/eat26.d.ts +12 -0
- package/dist/esm/inventories/eat26.js +108 -0
- package/dist/esm/inventories/gds15.d.ts +11 -0
- package/dist/esm/inventories/gds15.js +78 -0
- package/dist/esm/inventories/index.d.ts +14 -1
- package/dist/esm/inventories/index.js +24 -0
- package/dist/esm/inventories/pc-ptsd-5.d.ts +12 -0
- package/dist/esm/inventories/pc-ptsd-5.js +88 -0
- package/dist/esm/inventories/pcl5.d.ts +10 -0
- package/dist/esm/inventories/pcl5.js +121 -0
- package/dist/esm/inventories/phq15.d.ts +10 -0
- package/dist/esm/inventories/phq15.js +71 -0
- package/dist/esm/inventories/phq4.d.ts +11 -0
- package/dist/esm/inventories/phq4.js +70 -0
- package/dist/esm/inventories/phq8.d.ts +11 -0
- package/dist/esm/inventories/phq8.js +68 -0
- package/dist/esm/inventories/tipi.d.ts +10 -0
- package/dist/esm/inventories/tipi.js +67 -0
- package/dist/esm/inventories/ucla-ls3.d.ts +10 -0
- package/dist/esm/inventories/ucla-ls3.js +124 -0
- package/dist/esm/locales/de/cbi.d.ts +7 -0
- package/dist/esm/locales/de/cbi.js +108 -0
- package/dist/esm/locales/de/csi16.d.ts +3 -0
- package/dist/esm/locales/de/csi16.js +59 -0
- package/dist/esm/locales/de/eat26.d.ts +3 -0
- package/dist/esm/locales/de/eat26.js +45 -0
- package/dist/esm/locales/de/gds15.d.ts +4 -0
- package/dist/esm/locales/de/gds15.js +32 -0
- package/dist/esm/locales/de/pc-ptsd-5.d.ts +4 -0
- package/dist/esm/locales/de/pc-ptsd-5.js +30 -0
- package/dist/esm/locales/de/pcl5.d.ts +4 -0
- package/dist/esm/locales/de/pcl5.js +46 -0
- package/dist/esm/locales/de/phq15.d.ts +4 -0
- package/dist/esm/locales/de/phq15.js +33 -0
- package/dist/esm/locales/de/phq4.d.ts +4 -0
- package/dist/esm/locales/de/phq4.js +33 -0
- package/dist/esm/locales/de/phq8.d.ts +4 -0
- package/dist/esm/locales/de/phq8.js +33 -0
- package/dist/esm/locales/de/tipi.d.ts +4 -0
- package/dist/esm/locales/de/tipi.js +37 -0
- package/dist/esm/locales/de/ucla-ls3.d.ts +4 -0
- package/dist/esm/locales/de/ucla-ls3.js +46 -0
- package/dist/esm/locales/es/cbi.d.ts +7 -0
- package/dist/esm/locales/es/cbi.js +108 -0
- package/dist/esm/locales/es/csi16.d.ts +3 -0
- package/dist/esm/locales/es/csi16.js +66 -0
- package/dist/esm/locales/es/eat26.d.ts +3 -0
- package/dist/esm/locales/es/eat26.js +45 -0
- package/dist/esm/locales/es/gds15.d.ts +4 -0
- package/dist/esm/locales/es/gds15.js +32 -0
- package/dist/esm/locales/es/pc-ptsd-5.d.ts +4 -0
- package/dist/esm/locales/es/pc-ptsd-5.js +30 -0
- package/dist/esm/locales/es/pcl5.d.ts +4 -0
- package/dist/esm/locales/es/pcl5.js +46 -0
- package/dist/esm/locales/es/phq15.d.ts +4 -0
- package/dist/esm/locales/es/phq15.js +33 -0
- package/dist/esm/locales/es/phq4.d.ts +4 -0
- package/dist/esm/locales/es/phq4.js +33 -0
- package/dist/esm/locales/es/phq8.d.ts +4 -0
- package/dist/esm/locales/es/phq8.js +33 -0
- package/dist/esm/locales/es/tipi.d.ts +4 -0
- package/dist/esm/locales/es/tipi.js +37 -0
- package/dist/esm/locales/es/ucla-ls3.d.ts +4 -0
- package/dist/esm/locales/es/ucla-ls3.js +42 -0
- package/dist/esm/locales/index.js +66 -0
- package/dist/esm/locales/tr/cbi.d.ts +8 -0
- package/dist/esm/locales/tr/cbi.js +109 -0
- package/dist/esm/locales/tr/csi16.d.ts +3 -0
- package/dist/esm/locales/tr/csi16.js +66 -0
- package/dist/esm/locales/tr/eat26.d.ts +3 -0
- package/dist/esm/locales/tr/eat26.js +45 -0
- package/dist/esm/locales/tr/gds15.d.ts +4 -0
- package/dist/esm/locales/tr/gds15.js +32 -0
- package/dist/esm/locales/tr/pc-ptsd-5.d.ts +4 -0
- package/dist/esm/locales/tr/pc-ptsd-5.js +30 -0
- package/dist/esm/locales/tr/pcl5.d.ts +4 -0
- package/dist/esm/locales/tr/pcl5.js +46 -0
- package/dist/esm/locales/tr/phq15.d.ts +4 -0
- package/dist/esm/locales/tr/phq15.js +33 -0
- package/dist/esm/locales/tr/phq4.d.ts +4 -0
- package/dist/esm/locales/tr/phq4.js +33 -0
- package/dist/esm/locales/tr/phq8.d.ts +4 -0
- package/dist/esm/locales/tr/phq8.js +31 -0
- package/dist/esm/locales/tr/tipi.d.ts +4 -0
- package/dist/esm/locales/tr/tipi.js +37 -0
- package/dist/esm/locales/tr/ucla-ls3.d.ts +4 -0
- package/dist/esm/locales/tr/ucla-ls3.js +42 -0
- package/dist/esm/locales/zh/cbi.d.ts +7 -0
- package/dist/esm/locales/zh/cbi.js +108 -0
- package/dist/esm/locales/zh/csi16.d.ts +3 -0
- package/dist/esm/locales/zh/csi16.js +44 -0
- package/dist/esm/locales/zh/eat26.d.ts +3 -0
- package/dist/esm/locales/zh/eat26.js +43 -0
- package/dist/esm/locales/zh/gds15.d.ts +4 -0
- package/dist/esm/locales/zh/gds15.js +32 -0
- package/dist/esm/locales/zh/pc-ptsd-5.d.ts +4 -0
- package/dist/esm/locales/zh/pc-ptsd-5.js +30 -0
- package/dist/esm/locales/zh/pcl5.d.ts +4 -0
- package/dist/esm/locales/zh/pcl5.js +42 -0
- package/dist/esm/locales/zh/phq15.d.ts +4 -0
- package/dist/esm/locales/zh/phq15.js +33 -0
- package/dist/esm/locales/zh/phq4.d.ts +4 -0
- package/dist/esm/locales/zh/phq4.js +33 -0
- package/dist/esm/locales/zh/phq8.d.ts +4 -0
- package/dist/esm/locales/zh/phq8.js +29 -0
- package/dist/esm/locales/zh/tipi.d.ts +4 -0
- package/dist/esm/locales/zh/tipi.js +29 -0
- package/dist/esm/locales/zh/ucla-ls3.d.ts +4 -0
- package/dist/esm/locales/zh/ucla-ls3.js +32 -0
- package/dist/esm/types.d.ts +10 -2
- package/package.json +22 -3
- package/src/inventories/cbi.ts +131 -0
- package/src/inventories/csi16.ts +189 -0
- package/src/inventories/eat26.ts +118 -0
- package/src/inventories/gds15.ts +87 -0
- package/src/inventories/index.ts +36 -1
- package/src/inventories/pc-ptsd-5.ts +96 -0
- package/src/inventories/pcl5.ts +127 -0
- package/src/inventories/phq15.ts +77 -0
- package/src/inventories/phq4.ts +76 -0
- package/src/inventories/phq8.ts +73 -0
- package/src/inventories/tipi.ts +74 -0
- package/src/inventories/ucla-ls3.ts +131 -0
- package/src/locales/de/cbi.ts +111 -0
- package/src/locales/de/csi16.ts +66 -0
- package/src/locales/de/eat26.ts +52 -0
- package/src/locales/de/gds15.ts +35 -0
- package/src/locales/de/pc-ptsd-5.ts +35 -0
- package/src/locales/de/pcl5.ts +51 -0
- package/src/locales/de/phq15.ts +38 -0
- package/src/locales/de/phq4.ts +37 -0
- package/src/locales/de/phq8.ts +37 -0
- package/src/locales/de/tipi.ts +42 -0
- package/src/locales/de/ucla-ls3.ts +51 -0
- package/src/locales/es/cbi.ts +111 -0
- package/src/locales/es/csi16.ts +73 -0
- package/src/locales/es/eat26.ts +52 -0
- package/src/locales/es/gds15.ts +35 -0
- package/src/locales/es/pc-ptsd-5.ts +35 -0
- package/src/locales/es/pcl5.ts +51 -0
- package/src/locales/es/phq15.ts +37 -0
- package/src/locales/es/phq4.ts +37 -0
- package/src/locales/es/phq8.ts +38 -0
- package/src/locales/es/tipi.ts +42 -0
- package/src/locales/es/ucla-ls3.ts +47 -0
- package/src/locales/index.ts +66 -0
- package/src/locales/tr/cbi.ts +112 -0
- package/src/locales/tr/csi16.ts +73 -0
- package/src/locales/tr/eat26.ts +52 -0
- package/src/locales/tr/gds15.ts +35 -0
- package/src/locales/tr/pc-ptsd-5.ts +35 -0
- package/src/locales/tr/pcl5.ts +51 -0
- package/src/locales/tr/phq15.ts +37 -0
- package/src/locales/tr/phq4.ts +37 -0
- package/src/locales/tr/phq8.ts +35 -0
- package/src/locales/tr/tipi.ts +42 -0
- package/src/locales/tr/ucla-ls3.ts +46 -0
- package/src/locales/zh/cbi.ts +111 -0
- package/src/locales/zh/csi16.ts +51 -0
- package/src/locales/zh/eat26.ts +48 -0
- package/src/locales/zh/gds15.ts +35 -0
- package/src/locales/zh/pc-ptsd-5.ts +35 -0
- package/src/locales/zh/pcl5.ts +46 -0
- package/src/locales/zh/phq15.ts +36 -0
- package/src/locales/zh/phq4.ts +36 -0
- package/src/locales/zh/phq8.ts +32 -0
- package/src/locales/zh/tipi.ts +33 -0
- package/src/locales/zh/ucla-ls3.ts +36 -0
- package/src/types.ts +10 -1
package/LICENSE
CHANGED
|
@@ -6,7 +6,7 @@ everything that makes psytools run — is licensed under the MIT
|
|
|
6
6
|
License below. Copyright (c) 2026 Samed Kahyaoglu.
|
|
7
7
|
|
|
8
8
|
The bundled instrument text — the titles, descriptions, instructions,
|
|
9
|
-
item wording, and answer-option labels of the
|
|
9
|
+
item wording, and answer-option labels of the thirty-two third-party
|
|
10
10
|
psychological assessment instruments psytools ships, in every
|
|
11
11
|
language psytools provides them — is licensed by each instrument's
|
|
12
12
|
own rights holder, on the terms recorded instrument by instrument in
|
|
@@ -20,10 +20,13 @@ permission before commercial use: the ECR-R, the ERQ, and the HSPS,
|
|
|
20
20
|
which SOURCES.md tags "Research only," and the SWLS and the
|
|
21
21
|
Flourishing Scale, which SOURCES.md tags "Free with conditions" but
|
|
22
22
|
whose own terms are non-commercial-only — the same restriction in
|
|
23
|
-
substance, under a different tag.
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
23
|
+
substance, under a different tag. One more, the EAT-26, is free for
|
|
24
|
+
individual use but requires a licensing agreement from its copyright
|
|
25
|
+
holder for commercial web platforms that charge user fees. Four
|
|
26
|
+
others — the AQ-10, the RSES, the CSI-16, and the UCLA Loneliness
|
|
27
|
+
Scale — are neither free nor restricted for commercial use: their
|
|
28
|
+
rights holders simply haven't addressed it, so confirm with them
|
|
29
|
+
before shipping commercially. Read SOURCES.md before you rely on any
|
|
27
30
|
instrument's text, particularly before commercial use.
|
|
28
31
|
|
|
29
32
|
The MIT License below is the license for the code. The bundled
|
package/README.md
CHANGED
|
@@ -19,7 +19,7 @@ That's a complete depression screening: standardized items, answer validation, p
|
|
|
19
19
|
|
|
20
20
|
## Why psytools
|
|
21
21
|
|
|
22
|
-
- **Batteries included** —
|
|
22
|
+
- **Batteries included** — thirty-two instruments (PHQ-9, PHQ-15, GAD-7, DASS-21, WHO-5, ASRS, AQ-10, AUDIT, Mini-IPIP, Mini-IPIP6, CES-D, ECR-R, ERQ, HSPS, SWLS, Flourishing, K10, K6, RSES, IPIP BIS/BAS, IPIP-NEO-60, IPIP-VIA-R, PCL-5, EAT-26, CSI-16, UCLA Loneliness Scale, CBI, PC-PTSD-5, PHQ-4, PHQ-8, GDS-15, TIPI) ship ready to use in up to five languages (English, Turkish, German, Chinese, Spanish — see the table below), with published scoring rules, citations, and filtering metadata (category, target audience, respondent role).
|
|
23
23
|
- **Your tests too** — therapists and researchers can define their own instruments as one plain JSON object; psytools validates, localizes, and scores them the same way.
|
|
24
24
|
- **Everything is plain JSON** — assessments and responses `stringify()`/`parse()` losslessly, so definitions live in your database and travel between backend and frontend. Scoring rules are data, not code, and survive the round trip.
|
|
25
25
|
- **Safe by default** — every answer is validated against the option scale, incomplete responses can't be scored accidentally, and submitted responses are immutable.
|
|
@@ -104,8 +104,23 @@ const response = AssessmentResponse.parse(assessment, rowFromDb); // answers re-
|
|
|
104
104
|
| `bis-bas` | IPIP BIS/BAS scales (approach and avoidance motivation) | personality, motivation | 36 | 4 subscales (BIS 10, fun-seeking 10, drive 10, reward responsiveness 6), 10 reverse-keyed, no cutoffs | en, tr, de, zh, es |
|
|
105
105
|
| `ipip-neo-60` | IPIP-NEO-60 personality inventory | personality | 60 | 5 domain subscales × 12 items (12–60 each), 23 reverse-keyed, no cutoffs | en, tr, de, zh, es |
|
|
106
106
|
| `ipip-via-r` | IPIP-VIA-R short scales (24 character strengths) | character-strengths, personality | 96 | 24 strength subscales × 4 items (4–20 each), balanced 2 positive / 2 reverse, no cutoffs | en, tr, de, zh, es |
|
|
107
|
+
| `phq15` | Patient Health Questionnaire-15 (somatic symptoms) | somatic-symptoms | 15 | Sum 0–30 (0–2 coding), 4 severity bands, item 4 optional (women only) | en, tr, de, zh, es |
|
|
108
|
+
| `pcl5` | PTSD Checklist for DSM-5 (PCL-5), standard form | post-traumatic-stress | 20 | Sum 0–80, no bands² | en, tr, de, zh, es |
|
|
109
|
+
| `eat26` | Eating Attitudes Test (EAT-26) | disordered-eating | 26 | Sum 0–78 on an asymmetric key, referral at ≥20 | en, tr, de, zh, es |
|
|
110
|
+
| `csi16` | Couples Satisfaction Index (CSI-16) | relationships | 16 | Sum 0–81, **higher is better**, dissatisfied below 51.5 | en, tr, de, zh, es |
|
|
111
|
+
| `ucla-ls3` | UCLA Loneliness Scale (Version 3) | loneliness | 20 | Sum 20–80, 9 reverse-keyed items, no bands² | en, tr, de, zh, es |
|
|
112
|
+
| `cbi` | Copenhagen Burnout Inventory (CBI) | burnout | 19 | Three scales scored separately, sums; published score is the mean on 0–100, no bands² | en, tr, de, zh, es |
|
|
113
|
+
| `pc-ptsd-5` | Primary Care PTSD Screen for DSM-5 (PC-PTSD-5) | post-traumatic-stress | 1 + 5 | Lifetime trauma-exposure question gating 5 yes/no items; count of yes 0–5, no bands² | en, tr, de, zh, es |
|
|
114
|
+
| `phq4` | Patient Health Questionnaire-4 (anxiety and depression) | depression, anxiety | 4 | GAD-2 and PHQ-2 subscales (0–6, positive at ≥3) plus the 0–12 total, total unbanded³ | en, tr, de, zh, es |
|
|
115
|
+
| `phq8` | Patient Health Questionnaire-8 (PHQ-9 without the self-harm item) | depression | 8 | Sum 0–24, PHQ-9 cutpoints (5, 10, 15, 20), no suicidality flag | en, tr, de, zh, es |
|
|
116
|
+
| `gds15` | Geriatric Depression Scale, short form (GDS-15) | depression | 15 | Yes/no, 1 point per depressive answer (5 keyed on no), 0–15; >5 suggestive, >10 almost always depression | en, tr, de, zh, es |
|
|
117
|
+
| `tipi` | Ten-Item Personality Inventory (TIPI) | personality | 10 | 5 Big Five scales × 2 items (2–14 each), one reverse-keyed item per scale, no cutoffs | en, tr, de, zh, es |
|
|
107
118
|
|
|
108
|
-
¹ The `ecr-r` and `hsps` Turkish packs reproduce **published, validated Turkish adaptations** (Sümer and colleagues — see [SOURCES.md](SOURCES.md)); other locales can follow once verified sources are available. `ecr-r`, `erq`, and `hsps` are licensed for **non-commercial research use only** — check [SOURCES.md](SOURCES.md) before shipping them in a product. `asrs6` is free to ship, commercially included, but its license makes attribution mandatory: render `meta.attribution` wherever it appears.
|
|
119
|
+
¹ The `ecr-r` and `hsps` Turkish packs reproduce **published, validated Turkish adaptations** (Sümer and colleagues — see [SOURCES.md](SOURCES.md)); other locales can follow once verified sources are available. `ecr-r`, `erq`, and `hsps` are licensed for **non-commercial research use only** — check [SOURCES.md](SOURCES.md) before shipping them in a product. `asrs6` is free to ship, commercially included, but its license makes attribution mandatory: render `meta.attribution` wherever it appears. `eat26` is free for individual use but a **commercial web platform that charges user fees needs a licensing agreement** from its copyright holder — read its section in [SOURCES.md](SOURCES.md) before you build one. `cbi` has the thinnest licensing record of anything bundled — its steward publishes it openly but its rights holders have never granted anything in writing; read its section too.
|
|
120
|
+
|
|
121
|
+
² `pcl5`, `ucla-ls3`, `cbi` and `pc-ptsd-5` ship no severity bands, because their rights holders publish none to ship: the VA offers a PCL-5 cutoff *range* (31–33) it describes as initial research and tells PC-PTSD-5 users to choose a cut-point for their own sample, Russell scores the loneliness scale continuously, and the CBI's authors publish population norms rather than thresholds. Each records what is published in `meta.scoringNote` so you can apply your own threshold. Note also that `csi16` runs the opposite way to every other inventory here — a high score is a good result — so do not wire it to a shared "higher is worse" display. `pc-ptsd-5` opens with a trauma-exposure question that gates the five symptom items; psytools scores a "no" correctly as 0 but cannot hide the items for you, so show them only after a "yes" (see `meta.renderingNote`).
|
|
122
|
+
|
|
123
|
+
³ The PHQ-4 total-score categories that circulate (0–2, 3–5, 6–8, 9–12) could not be checked against the rights holder's manual or the validation paper, so the total ships unbanded; its two subscales carry the manual's cutpoint of 3. See [SOURCES.md](SOURCES.md).
|
|
109
124
|
|
|
110
125
|
```ts
|
|
111
126
|
import { loadInventory, inventories, dass21 } from "psytools";
|
|
@@ -131,7 +146,9 @@ Every definition carries three optional fields for picking the right instrument:
|
|
|
131
146
|
|
|
132
147
|
Audience and respondent are separate axes because instruments *about* children are commonly filled in by someone else — a parent-report ADHD scale is `audience: ["child"]`, `respondent: "parent"`. `audience` is an array, since one wording is often validated across bands; `respondent` is a single value, since a definition is written from exactly one point of view. Parent- and teacher-report forms of the same instrument say "your child" and "this student", so they are separate definitions with separate ids, not one definition with two respondents.
|
|
133
148
|
|
|
134
|
-
Neither field encodes the recall timeframe or the administration mode: a retrospective instrument answered by an adult about their own childhood is `["adult"]` + `"self"`, with the childhood framing in `instructions`, and a clinician reading items aloud to a client is still `"self"` because the answers are the client's own report. Every bundled inventory is `respondent: "self"` and `audience: ["adult"]`, except `rses` — Rosenberg developed
|
|
149
|
+
Neither field encodes the recall timeframe or the administration mode: a retrospective instrument answered by an adult about their own childhood is `["adult"]` + `"self"`, with the childhood framing in `instructions`, and a clinician reading items aloud to a client is still `"self"` because the answers are the client's own report. Every bundled inventory is `respondent: "self"` and `audience: ["adult"]`, except `rses` and `eat26`, which are both `["adolescent", "adult"]` — Rosenberg developed his scale on high-school students, Garner names high school and college among the EAT-26's screening populations, and neither instrument changes its wording between bands.
|
|
150
|
+
|
|
151
|
+
No bundled inventory is adolescent- or child-only yet, and none has a `respondent` other than `"self"`. That reflects who licenses their instruments freely, not what exists — the parent- and teacher-report scales that would fill those gaps are recorded, with their terms, under [instruments evaluated and not bundled](SOURCES.md#instruments-evaluated-and-not-bundled).
|
|
135
152
|
|
|
136
153
|
## Defining your own assessment
|
|
137
154
|
|
|
@@ -227,7 +244,7 @@ scoring: {
|
|
|
227
244
|
|
|
228
245
|
`ignore` sums what is answered (partial totals understate severity — use deliberately); `prorate` scales the raw score up to the full item count (rounded) and refuses to score below `minAnswered`; `require-complete` throws unless every contributing non-optional item is answered. For subscale scoring the policy applies to each subscale independently.
|
|
229
246
|
|
|
230
|
-
The bundled inventories ship with policies (PHQ-9/GAD-7/DASS-21 and the five IPIP inventories prorate with thresholds, WHO-5/ASRS/AQ-10 require-complete, AUDIT ignores to match its skip logic) — see [SOURCES.md](SOURCES.md#missing-data-policies) for the rationale and how to override.
|
|
247
|
+
The bundled inventories ship with policies (PHQ-9/GAD-7/DASS-21 and the five IPIP inventories prorate with thresholds, WHO-5/ASRS/AQ-10/CSI-16 require-complete, AUDIT ignores to match its skip logic, PHQ-15 ignores because its item 4 is marked women-only on the instrument, PC-PTSD-5 ignores because its symptom items are skipped after a "no" to the exposure question, GDS-15 prorates by its authors' own rule) — see [SOURCES.md](SOURCES.md#missing-data-policies) for the rationale and how to override.
|
|
231
248
|
|
|
232
249
|
## Custom evaluation
|
|
233
250
|
|
|
@@ -285,7 +302,7 @@ npm run build # ESM + CJS + type declarations into dist/
|
|
|
285
302
|
|
|
286
303
|
- **Not a diagnostic tool.** Scores, severity bands, and flags implement the published scoring rules of screening instruments; they are not diagnoses and do not replace clinical judgment.
|
|
287
304
|
- **Crisis-relevant answers.** PHQ-9 item 9 raises a `suicidality` flag — applications should surface this to a responsible clinician and provide crisis resources to respondents.
|
|
288
|
-
- **Instrument licensing.** [SOURCES.md](SOURCES.md) records who holds the rights to each bundled instrument and flags it **Free** (PHQ-9, GAD-7, DASS-21, WHO-5, AUDIT, CES-D, K10, K6,
|
|
305
|
+
- **Instrument licensing.** [SOURCES.md](SOURCES.md) records who holds the rights to each bundled instrument and flags it **Free** (PHQ-9, GAD-7, DASS-21, WHO-5, AUDIT, CES-D, K10, K6, the five IPIP inventories, PC-PTSD-5, PHQ-4, PHQ-8, GDS-15 and TIPI — usable without permission, including commercially), **Free with conditions** (ASRS screener, AQ-10, SWLS, Flourishing Scale, RSES — free as distributed, but the conditions differ per instrument: the ASRS screener requires attribution, the AQ-10's commercial terms are unstated), or **Research only** (ECR-R, ERQ, HSPS — not licensed for clinical products or personnel selection). Each inventory's `meta.licenseFlag` carries the flag programmatically; read the instrument's section before shipping it.
|
|
289
306
|
- **Required attribution.** Where a license fixes the exact credit line that must be displayed, the inventory carries it verbatim in `meta.attribution` — render it wherever the instrument or its results appear. Today only `asrs6` sets it (© New York University and the President and Fellows of Harvard College). It is deliberately separate from `meta.reference`, which is the scientific citation: an academic reference is not a copyright attribution, and only one of the two is a license obligation.
|
|
290
307
|
- **Translation provenance.** English texts are reproduced from the original instruments. Turkish, German, Simplified Chinese, and Spanish texts are AI translations (Anthropic Claude — the exact model is named per inventory in `meta.translationProvenance`) of the original English — official translations were **not** consulted and the texts are unverified. This status is documentation-only: psytools does not track or expose per-pack verification programmatically (no `verified` field, no gating option, no status API) — read [SOURCES.md](SOURCES.md) and decide for yourself whether the bundled wording is fit for your use case. If it isn't for a specific item, use [local overrides](#local-translation-overrides) rather than forking the package. Obtain and compare the official version for your language before clinical use. Corrections: <samed@luckys.dev>.
|
|
291
308
|
|
|
@@ -293,9 +310,9 @@ npm run build # ESM + CJS + type declarations into dist/
|
|
|
293
310
|
|
|
294
311
|
The code is MIT — Samed Kahyaoglu, 2026. See [LICENSE](LICENSE).
|
|
295
312
|
|
|
296
|
-
The bundled instrument text is a separate matter: each of the
|
|
313
|
+
The bundled instrument text is a separate matter: each of the thirty-two instruments is licensed by its own rights holder, on terms that differ instrument to instrument. The quick answer:
|
|
297
314
|
|
|
298
|
-
- **
|
|
315
|
+
- **Eighteen ship free, including in commercial products, no permission needed:** PHQ-9, GAD-7, DASS-21, WHO-5, AUDIT, CES-D, K10, K6, PC-PTSD-5, PHQ-4, PHQ-8, GDS-15, TIPI, and the five International Personality Item Pool inventories — Mini-IPIP, Mini-IPIP6, IPIP BIS/BAS, IPIP-NEO-60, IPIP-VIA-R. The IPIP five carry the least conditional terms in the package: "Because the IPIP has been placed in the public domain, permission has already been automatically granted for any person to use IPIP items, scales, and inventories for any purpose, commercial or non-commercial" — no attribution required, no one to ask.
|
|
299
316
|
- **The ASRS-v1.1 screener (`asrs6`) ships free, including commercially, with one mandatory condition — attribution.** Render the credit line psytools ships in `meta.attribution` wherever the screener or its results appear.
|
|
300
317
|
- **Three ship for non-commercial research only: ECR-R, ERQ, and HSPS.** Commercial use of any of these needs permission directly from that instrument's own rights holder (R. C. Fraley for the ECR-R; the Stanford Psychophysiology Laboratory for the ERQ; Elaine Aron for the HSPS) — that permission is theirs to give, not psytools'.
|
|
301
318
|
- **AQ-10, RSES, SWLS, and the Flourishing Scale ship free with conditions of their own, and the conditions aren't uniform.** AQ-10's and RSES's rights holders haven't addressed commercial use (confirm with them before shipping commercially). SWLS's and the Flourishing Scale's rights holder (Ed Diener and co-authors) licenses them for non-commercial purposes only — treat those two like the research-only three for commercial shipping.
|
package/SOURCES.md
CHANGED
|
@@ -24,7 +24,7 @@ The same provenance applies to every bundled inventory **except where an invento
|
|
|
24
24
|
| zh | AI translation (Anthropic Claude) from the original English | No |
|
|
25
25
|
| es | AI translation (Anthropic Claude) from the original English | No |
|
|
26
26
|
|
|
27
|
-
The exact translating model is stated per inventory in `meta.translationProvenance` (`claude-fable-5` for the original batch, `claude-sonnet-5` for later additions, `claude-opus-5` for the IPIP batch).
|
|
27
|
+
The exact translating model is stated per inventory in `meta.translationProvenance` (`claude-fable-5` for the original batch, `claude-sonnet-5` for later additions, `claude-opus-5` for the IPIP batch and the 2026-07 coverage wave, `claude-opus-5-5` for the 2026-11 free-screeners wave).
|
|
28
28
|
|
|
29
29
|
Official validated translations exist for most of these instruments, but they were **not consulted** in preparing the bundled texts, so they are deliberately not cited as sources. The packaged non-English wording has not been checked against them and has not been psychometrically validated. Validated instruments are only validated for their exact wording — before clinical or research use, obtain the official version for your language and compare or replace the text.
|
|
30
30
|
|
|
@@ -36,7 +36,9 @@ This table is the only place translation status is tracked — psytools has no `
|
|
|
36
36
|
|
|
37
37
|
Each inventory declares two independent axes in its definition: `audience`, the age band(s) the instrument is written and validated for — who it is *about* — and `respondent`, whose report the answers are. They are separate because instruments about children are commonly completed by a parent or a teacher rather than by the child.
|
|
38
38
|
|
|
39
|
-
**Every bundled inventory is `respondent: "self"` and `audience: ["adult"]`, except where its section below states otherwise.**
|
|
39
|
+
**Every bundled inventory is `respondent: "self"` and `audience: ["adult"]`, except where its section below states otherwise.** Two deviate today, both by widening rather than narrowing: the RSES and the EAT-26 are each `["adolescent", "adult"]`, because the same wording is standard for both bands.
|
|
40
|
+
|
|
41
|
+
Two gaps are worth naming, since they are what the fields exist for and neither is filled yet. **No bundled inventory is written for adolescents or children only**, and **none has a `respondent` other than `"self"`** — no parent- or teacher-report form is bundled. The instruments that would fill those gaps are, so far, the ones whose rights holders restrict redistribution: the parent and teacher Vanderbilt scales, the SDQ, and the CRAFFT all sit in [instruments evaluated and not bundled](#instruments-evaluated-and-not-bundled) below. Filter on `audience` and `respondent` by all means, but do not read today's values as a survey of what exists.
|
|
40
42
|
|
|
41
43
|
Two things `audience` and `respondent` deliberately do *not* encode:
|
|
42
44
|
|
|
@@ -65,6 +67,17 @@ Bundled inventories ship with declarative missing-data policies (`scoring.missin
|
|
|
65
67
|
| `bis-bas` | prorate, ≥5 per subscale | One threshold serves subscales of 10, 10, 10, and 6 items, so it is pinned to the strictest value the 6-item subscale allows — 5 of 6 there, 5 of 10 on the others |
|
|
66
68
|
| `ipip-neo-60` | prorate, ≥9 of 12 per domain | Common research practice (75% completion) |
|
|
67
69
|
| `ipip-via-r` | prorate, ≥3 of 4 per strength | 75% completion; note that dropping one item of a balanced 2-positive/2-negative scale reintroduces acquiescence bias |
|
|
70
|
+
| `phq15` | ignore | Item 4 is printed "[women only]" on the instrument, so it is legitimately unanswered by around half of respondents; an unanswered item contributes 0, which is what the instrument's own total-score line does. Prorating would inflate a man's score by 15/14 for answering the form as printed. The usual `ignore` caveat still applies to an accidental skip |
|
|
71
|
+
| `pcl5` | prorate, ≥16 of 20 | Common research practice (≈80% completion) — the same threshold as `cesd`, the package's other 20-item sum. The VA publishes no prorating rule of its own |
|
|
72
|
+
| `eat26` | prorate, ≥21 of 26 | Common research practice (≈80% completion) |
|
|
73
|
+
| `csi16` | require-complete | The authors' scoring instruction is a plain sum over all sixteen items, and their 51.5 cutoff is calibrated to the full 0–81 range. No prorating rule is published, and inventing one would move a clinical threshold |
|
|
74
|
+
| `ucla-ls3` | prorate, ≥16 of 20 | Common research practice (≈80% completion); the score is continuous with no cutoff, so prorating carries no risk of tipping a respondent across a threshold |
|
|
75
|
+
| `cbi` | prorate, ≥4 per scale | The authors' own rule is 3 of 6 (personal), 4 of 7 (work), 3 of 6 (client). One policy cannot carry three thresholds, so it is pinned to the strictest — stricter than the authors on the two 6-item scales, which fails safe. Prorating is the authors' method: their score is the mean of the answered items |
|
|
76
|
+
| `pc-ptsd-5` | ignore | The five symptom items are gated: a respondent who denies trauma exposure stops after the first question, and the VA scores that response 0. The symptom items are therefore `optional`, and an unanswered one contributes 0. Prorating would be wrong for the same reason it is wrong for `phq15`. The usual `ignore` caveat applies to an accidental skip after a "yes" |
|
|
77
|
+
| `phq4` | require-complete | Each subscale has two items, so one missing answer removes half of it, and the cutpoint of 3 is undefined for a single item |
|
|
78
|
+
| `phq8` | prorate, ≥6 of 8 answered | Common research practice (75% completion), the same rate as `phq9` |
|
|
79
|
+
| `gds15` | prorate, ≥10 of 15 answered | The authors' own rule: prorate the answered items to 15, and treat more than 5 missing as invalid (<https://web.stanford.edu/~yesavage/GDS.html>). They round a fractional result up; psytools rounds to the nearest integer, so a .5 lands the same way and anything else may land one point lower |
|
|
80
|
+
| `tipi` | require-complete | Two items per scale; a score from one item is not the instrument's score |
|
|
68
81
|
|
|
69
82
|
## PHQ-9 — Patient Health Questionnaire-9 (`phq9`)
|
|
70
83
|
|
|
@@ -249,9 +262,149 @@ Five bundled inventories are drawn from the International Personality Item Pool
|
|
|
249
262
|
- **Reliability is modest for several scales, by construction.** Four items divided between two wordings buys balance at the cost of internal consistency. The authors report McDonald's ω between .57 and .84 across German and UK samples and argue that Cronbach's α is the wrong estimate for a balanced scale of this shape; α runs as low as .42 (self-regulation, UK). Treat single-strength scores as indicative, not precise. The 2–3 week retest reliabilities (.53–.84) are the more useful number for most applications.
|
|
250
263
|
- **Scale labels.** IPIP lists several strengths under two or three names (for example "Industry/Perseverance/Persistence"). psytools keeps a descriptive label carrying the alternatives and uses a single short id (`perseverance`); the mapping is visible in the definition.
|
|
251
264
|
|
|
265
|
+
## PHQ-15 — Patient Health Questionnaire-15 (`phq15`)
|
|
266
|
+
|
|
267
|
+
**License: Free.** The same Pfizer grant as the bundled PHQ-9 and GAD-7, confirmed twice from primary sources. The instrument's own footer reads: "Copyright Pfizer Inc. No permission required to reproduce, translate, display, or distribute." The PHQ family's instruction manual says the same of the whole family and names the PHQ-15 explicitly in its table of measures: "All of the measures included in Table 1 are in the public domain. No permission is required to reproduce, translate, display or distribute." Official repository: <https://www.phqscreeners.com>.
|
|
268
|
+
|
|
269
|
+
- **Citation:** Kroenke, K., Spitzer, R. L., & Williams, J. B. W. (2002). The PHQ-15: Validity of a new measure for evaluating the severity of somatic symptoms. *Psychosomatic Medicine, 64*(2), 258–266.
|
|
270
|
+
- **Scoring:** Sum 0–30 on a 0–2 bother scale over the past 4 weeks. Bands split at the PHQ manual's own cutpoints of 5, 10 and 15 for low, medium and high somatic symptom severity.
|
|
271
|
+
- **Item 4 is optional, because the instrument says so.** "Menstrual cramps or other problems with your periods" is printed "[women only]" on the form. psytools marks it `optional`, and the missing-data policy is `ignore` so that a respondent who skips it is scored on what they answered — see [missing-data policies](#missing-data-policies) for why prorating would be wrong here.
|
|
272
|
+
- **Two items are shared with the PHQ-9, and the answers are not interchangeable.** Item 14 (tired) and item 15 (sleep) cover the same symptoms as PHQ-9 items 4 and 3. The wording is shorter here and, more importantly, the scale runs 0–2 rather than 0–3. Do not copy an answer from one inventory to the other; administer each on its own scale.
|
|
273
|
+
|
|
274
|
+
## PCL-5 — PTSD Checklist for DSM-5 (`pcl5`)
|
|
275
|
+
|
|
276
|
+
**License: Free.** The rights holder's own page states it without qualification: "This measure was developed by staff at VA's National Center for PTSD and is in the public domain and not copyrighted" (<https://www.ptsd.va.gov/professional/assessment/adult-sr/ptsd-checklist.asp>). English text transcribed from the VA's own PCL-5 Standard form PDF, version date 29 August 2023.
|
|
277
|
+
|
|
278
|
+
- **Citation:** Weathers, F. W., Litz, B. T., Keane, T. M., Palmieri, P. A., Marx, B. P., & Schnurr, P. P. (2013). *The PTSD Checklist for DSM-5 (PCL-5) — Standard* [Measurement instrument]. National Center for PTSD. Available from <https://www.ptsd.va.gov/>.
|
|
279
|
+
- **Scoring:** Sum 0–80 on a 0–4 scale, recall window one month. psytools bundles the standard form; the VA also publishes forms with a Criterion A event checklist and with an extended timeframe, which are not included.
|
|
280
|
+
- **No bands, and that is deliberate — the cutoff is provisional in the VA's own words.** The VA writes that "initial research suggests that a PCL-5 cutoff score between 31–33 is indicative of probable PTSD across samples," and asks users to weigh their own setting when choosing one. That is a range offered as initial research, not a settled threshold. A `band` renders to whoever is reading the result as a categorical verdict, so encoding one number out of 31–33 as a boundary would present a provisional finding as a decided one. The range is recorded in `meta.scoringNote` instead; apply your own cutoff over `score` if your protocol names one.
|
|
281
|
+
- **The DSM-5 provisional-diagnosis rule is not implemented.** The VA's second scoring route — at least one item from cluster B, one from C, two from D and two from E, each rated 2 or higher — needs per-cluster counts of items above a threshold, which none of psytools' three declarative scorings expresses. The cluster composition is recorded in `meta.scoringNote` (B: 1–5, C: 6–7, D: 8–14, E: 15–20) so a custom evaluator can implement it in a few lines.
|
|
282
|
+
|
|
283
|
+
## EAT-26 — Eating Attitudes Test (`eat26`)
|
|
284
|
+
|
|
285
|
+
**License: Free with conditions.** Copyright is held by David M. Garner / Eating Attitudes LLC. Fees and royalties are waived for individual users, and permission letters to reproduce paper or electronic copies are granted on request through the copyright holder's own site (<https://www.eat-26.com/permission/>). One exception is stated explicitly, and a consumer building a paid product needs to see it before they build:
|
|
286
|
+
|
|
287
|
+
> Commercial WEB platforms that charge user fees must obtain a licensing agreement from the copyright holder.
|
|
288
|
+
|
|
289
|
+
**Our position, stated separately from the rights holder's words above:** psytools is an open-source library, not a commercial web platform, and it charges no user fees — so we read that condition as landing on the deployment, not on the library, and bundle the text on that basis. **If you are building a web platform that charges user fees, the condition lands on you.** Contact <dmgarner@gmail.com> for a licensing agreement before you ship. The flag does not encode our reading; it says `free-with-conditions` and this section is the condition.
|
|
290
|
+
|
|
291
|
+
- **Citation:** Garner, D. M., Olmsted, M. P., Bohr, Y., & Garfinkel, P. E. (1982). The Eating Attitudes Test: Psychometric features and clinical correlates. *Psychological Medicine, 12*(4), 871–878.
|
|
292
|
+
- **Scoring:** Sum 0–78 on Garner's own asymmetric key, taken from his scoring and interpretation document. For items 1–25, Always scores 3, Usually 2, Often 1, and Sometimes, Rarely and Never all score 0; item 26 is keyed the other way round (Never 3, Rarely 2, Sometimes 1, the rest 0). A score of 20 or above is his referral criterion, which is where the two bands split. His three subscales — dieting, bulimia and food preoccupation, oral control — are recorded in `meta.scoringNote` but not scored, because the total is what carries the cutoff.
|
|
293
|
+
- **Three of the six answer anchors score the same number, so key your UI by option position.** That collapse is the instrument's, not ours: Garner's scoring table gives Sometimes, Rarely and Never an identical 0 on items 1–25. psytools' model stores an answer as its score contribution, so `value` alone cannot say which of the three a respondent picked. Render options and store raw responses by their index in the `options` array — `meta.renderingNote` repeats this next to the data.
|
|
294
|
+
- **psytools bundles Part B only, and Garner's referral logic is wider than that.** His full form has three parts: a demographic and BMI section (Part A), the 26 scored items (Part B), and five behavioural questions about bingeing, vomiting, laxatives, exercise and weight loss (Part C). Only Part B carries the 0–78 score, so only Part B is bundled. Garner refers a respondent on a score of 20 or above **or** on low age-referenced BMI **or** on any flagged behavioural answer — so a score below 20 does not, on its own, complete his screening protocol. Implement Parts A and C alongside if you are reproducing that protocol rather than the scale.
|
|
295
|
+
- **Audience — deviates from the default:** `audience: ["adolescent", "adult"]`. Garner's own scoring document describes the EAT-26 as "particularly useful as a screening tool to assess 'eating disorder risk' in high school, college and other special risk samples such as athletes," and the BMI referral criteria he publishes with it are age-referenced from age 9 upward. The item wording does not change between bands. We stop at adolescent rather than following the BMI table down to age 9, because high school and college is what the rights holder names.
|
|
296
|
+
|
|
297
|
+
## CSI-16 — Couples Satisfaction Index (`csi16`)
|
|
298
|
+
|
|
299
|
+
**License: Free with conditions.** Ronald Rogge and colleagues (University of Rochester) distribute the CSI scales from their own lab site, and the grant is printed both on the site and on the instrument file itself. The site says:
|
|
300
|
+
|
|
301
|
+
> These scales are freely available for use in both clinical and research settings. No additional permission is necessary for their use.
|
|
302
|
+
|
|
303
|
+
The CSI-16 file adds:
|
|
304
|
+
|
|
305
|
+
> PERMISSION FOR USE: We developed the CSI scales to be freely available for research and clinical use. No further permission is required beyond this form and the authors will not generate study-specific permission letters.
|
|
306
|
+
|
|
307
|
+
**This is the cleanest, least hedged grant of the four conditional instruments — and it still never says "commercial", in either direction.** Both statements scope themselves to clinical and research settings. There is no commercial carve-out to comply with, and no commercial permission to rely on; the authors simply did not address it, most likely because they had individual clinicians and researchers in mind rather than software redistribution. That silence is the whole of the condition, and the reason the flag is not `free`. **Our position:** we read a grant this unhedged as covering distribution of the item text in an open-source library, and bundle it. If your own use is commercial and you want certainty rather than a reasonable reading, ask the authors — the scales are hosted at <https://couples-research.com/measures/>.
|
|
308
|
+
|
|
309
|
+
- **Citation:** Funk, J. L., & Rogge, R. D. (2007). Testing the ruler with item response theory: Increasing precision of measurement for relationship satisfaction with the Couples Satisfaction Index. *Journal of Family Psychology, 21*(4), 572–583.
|
|
310
|
+
- **Scoring:** Sum 0–81. **Higher is more satisfied** — the opposite direction from every other bundled inventory, where a higher score means more of a problem. Do not wire a shared "higher is worse" display to this one. The authors' cutoff is 51.5, so the bands split at 51/52.
|
|
311
|
+
- **Four different answer scales, which is why most items carry their own `options`.** Item 1 is a 7-point 0–6 happiness scale ending in "Perfect"; item 2 runs 5 down to 0; items 3–6 are 0–5 agreement; items 7–10 use the assessment-level 0–5 scale; items 11–16 are semantic differentials.
|
|
312
|
+
- **Items 11–16 are semantic differentials and need a renderer that knows it.** Each is a pair of opposing words with six positions between them. psytools puts both poles in the question `text`, in the order the authors print them left to right, and labels the six options with the position numbers as printed on the authors' form. The authors note that when they administer the scale they replace those numbers with blank circles; a renderer wanting that should draw the poles from `text` at each end of a row of six controls. The locale packs restate the same digits rather than inventing words for the intermediate positions.
|
|
313
|
+
- **`instructions` is the form's only instruction line, and on paper it introduces items 11–16.** Items 1–10 carry self-contained stems and need no preamble. psytools has one instruction field per assessment, so that line is promoted to the assessment's `instructions`; it is reproduced verbatim rather than rewritten to cover all sixteen.
|
|
314
|
+
- **This inventory is the first to populate the `relationships` category on its own.** The category has been declared since the first release and was carried only as a secondary label on `ecr-r`, which measures attachment.
|
|
315
|
+
|
|
316
|
+
## UCLA Loneliness Scale, Version 3 (`ucla-ls3`)
|
|
317
|
+
|
|
318
|
+
**License: Free with conditions.** This is the thinnest licensing record of anything bundled, and the section is long because the reader deserves both halves of it.
|
|
319
|
+
|
|
320
|
+
Daniel W. Russell (Iowa State University) developed the scale and has publicly disclaimed any requirement to seek his permission. In a 2022 openly-licensed interview he described the daily requests he receives from graduate students "whose committees are telling them 'you have to get permission from the developer to use the scale' which is not true." That is current, first-person and unambiguous as far as it goes. What it is not is a formal licence: it is a remark in an interview, it is addressed to researchers rather than to redistributors, and it does not mention commercial use in either direction.
|
|
321
|
+
|
|
322
|
+
Set against it, without contradicting it: HealthMeasures lists Russell and the UCLA Loneliness Scale among the third-party content PROMIS uses **with the permission of the copyright holders**. The two facts sit together perfectly well — an author who tells students they need not ask can still receive and grant a formal institutional request — but a reader weighing their own risk should have both, so both are here.
|
|
323
|
+
|
|
324
|
+
**Our position:** on the strength of the author's own words we bundle the text and flag it `free-with-conditions` rather than `free`, because no licence exists to point at. If your use is commercial and you want certainty, write to Russell. We have not.
|
|
325
|
+
|
|
326
|
+
- **Citation:** Russell, D. W. (1996). UCLA Loneliness Scale (Version 3): Reliability, validity, and factor structure. *Journal of Personality Assessment, 66*(1), 20–40.
|
|
327
|
+
- **Item source — no first-party copy exists.** Russell distributes no copy of his own and the 1996 article is paywalled, so unlike every other instrument in this file the English text does not come from the rights holder. It is transcribed from two independent reproductions of Russell (1996), read and checked against each other: Stanford SPARQ's *Measuring Mobility* toolkit (<https://sparqtools.org/mobility-measure/ucla-loneliness-scale-version-3/>) and the Fetzer Institute's self-measures compendium. They agree item for item and on the reverse keys.
|
|
328
|
+
- **They disagree on the top anchor, and psytools follows "Always".** One prints Never / Rarely / Sometimes / **Often**, the other Never / Rarely / Sometimes / **Always**. Russell's own instruction example settles it — it ends "if you always feel happy, you would respond 'always'" — and "Often" belongs to the earlier Revised UCLA Loneliness Scale, a different instrument. This is exactly the kind of drift a single source would have shipped unnoticed.
|
|
329
|
+
- **Scoring:** Sum 20–80 on a 1–4 frequency scale, higher is lonelier. **Nine of the twenty items are reverse-keyed** — 1, 5, 6, 9, 10, 15, 16, 19 and 20, the positively worded ones. (Nine, not ten: descriptions of this scale sometimes quote "10 of the 20 items reverse scored", which is a statement about the earlier Revised version, not about Version 3.)
|
|
330
|
+
- **No bands, because Russell publishes no cutoffs.** The scale is scored continuously. Severity bandings for it circulate widely on the web; none of them traces back to Russell, so none is bundled.
|
|
331
|
+
|
|
332
|
+
## CBI — Copenhagen Burnout Inventory (`cbi`)
|
|
333
|
+
|
|
334
|
+
**License: Free with conditions.** Like the UCLA scale above, this record has two halves and you should have both.
|
|
335
|
+
|
|
336
|
+
**What supports it.** NFA — Det Nationale Forskningscenter for Arbejdsmiljø, Denmark's national occupational-health research institute — hosts the complete instrument in its public questionnaire library with no registration, no fee and no gate of any kind, under a named live contact (Thomas Clausen, <tcl@nfa.dk>). An independent peer-reviewed validation study describes it, citing Kristensen et al. by name, as "a public domain questionnaire." And the two published Turkish adaptations (2009, 2013) describe their method without describing a permission-seeking step — which carries some weight in this file specifically, because the Turkish teams behind the WURS-25, the WFIRS and the Athens Insomnia Scale all state plainly that they wrote and asked first.
|
|
337
|
+
|
|
338
|
+
**What is missing.** No statement from the rights holders themselves. NFA stewards and distributes the instrument; it did not write it. Two independent research passes went looking for a first-party grant and neither found one, and the original Kristensen et al. (2005) paper stayed paywalled across every route tried, so if it settles the question either way we have not read it. Nothing in the first-edition document itself — read in full — carries a copyright line, a licence, or a permission statement.
|
|
339
|
+
|
|
340
|
+
**Our position:** bundled on the strength of NFA's open hosting, and flagged `free-with-conditions` rather than `free` because there is no grant to point at. If your use is commercial and you want certainty, write to NFA. We have not.
|
|
341
|
+
|
|
342
|
+
- **Citation:** Kristensen, T. S., Borritz, M., Villadsen, E., & Christensen, K. B. (2005). The Copenhagen Burnout Inventory: A new tool for the assessment of burnout. *Work & Stress, 19*(3), 192–207.
|
|
343
|
+
- **Item source:** the authors' own English first edition (February 2004), by Marianne Borritz and Tage S. Kristensen at the National Institute of Occupational Health, Copenhagen, as hosted by NFA. Read in full, including the normative tables. **Single source** — unlike `ucla-ls3` there was no second reproduction to cross-check against, but unlike `ucla-ls3` this one comes from the authors themselves.
|
|
344
|
+
- **Development language was Danish**, for the PUMA study on a Danish population. The English text bundled here is the authors' own, not a third-party translation, so the file's general provenance rule still holds — but this is the first bundled instrument whose *development* language is not English, and that distinction is worth keeping in view as more non-English-origin instruments are considered.
|
|
345
|
+
- **Three scales, scored separately, no total.** Personal burnout (6 items), work-related burnout (7), client-related burnout (6). There is deliberately no score across all nineteen: the three ask about the same exhaustion under different attributions, and the authors treat them as independent.
|
|
346
|
+
- **Two response scales are mixed within a scale.** Items phrased as "is your work…" take a degree scale (To a very high degree … To a very low degree); items phrased as "how often…" take a frequency scale (Always … Never/almost never). Both map to the same 100 / 75 / 50 / 25 / 0 key, so a mis-assigned scale would produce a wrong score rather than an out-of-range answer — `test/evaluation.test.ts` pins which items carry which.
|
|
347
|
+
- **Scoring:** the published score for each scale is the **mean** of its items, on 0–100. psytools reports subscale sums; divide by 6, 7 and 6 respectively — the same convention the ECR-R, ERQ and HSPS entries follow. **One item is reverse-keyed**: work-burnout item 7 (`cbi-13`), on having energy left for family and friends, where more energy means less burnout.
|
|
348
|
+
- **Missing data:** the authors' own rule classifies a respondent as a non-responder below 3 of 6 answered (personal), 4 of 7 (work) and 3 of 6 (client). A single policy cannot carry three thresholds, so `minAnswered` is pinned to 4 — stricter than the authors on the two 6-item scales, which fails safe by refusing to score rather than scoring thin data.
|
|
349
|
+
- **No bands, because the authors publish norms rather than cutoffs.** The first edition gives population means (around 32.7 for personal burnout in a representative Danish sample, SD 15.7) and no severity thresholds, so none are bundled.
|
|
350
|
+
- **The authors ask that the items not be presented in the printed order**, and say they may be interleaved with questions on other topics, to avoid stereotyped response patterns. psytools keeps the published order so the definition stays checkable against the source — shuffle at presentation time if you follow the recommendation.
|
|
351
|
+
- **"Clients" is meant to be substituted.** The authors instruct that the term should match the setting — patients for nurses, students or children for teachers. The bundled instructions say so; the Turkish pack uses *danışan*, which is already the right word for a therapy setting.
|
|
352
|
+
|
|
353
|
+
## PC-PTSD-5: Primary Care PTSD Screen for DSM-5 (`pc-ptsd-5`)
|
|
354
|
+
|
|
355
|
+
**License: Free.** The rights holder's own page states it in the same words as for the PCL-5: "This measure was developed by staff at VA's National Center for PTSD and is in the public domain and not copyrighted" (<https://www.ptsd.va.gov/professional/assessment/screens/pc-ptsd.asp>). English text transcribed from the VA's own PC-PTSD-5 form PDF (`pc-ptsd-5-v6.pdf`, version date 2022), page 2, the respondent form. The VA's page renders the same items with the same wording.
|
|
356
|
+
|
|
357
|
+
- **Citation:** Prins, A., Bovin, M. J., Kimerling, R., Kaloupek, D. G., Marx, B. P., Pless Kaiser, A., & Schnurr, P. P. (2015). *The Primary Care PTSD Screen for DSM-5 (PC-PTSD-5)* [Measurement instrument]. Available from <https://www.ptsd.va.gov>. Validation: Prins, A., Bovin, M. J., Smolenski, D. J., et al. (2016). The Primary Care PTSD Screen for DSM-5 (PC-PTSD-5): Development and evaluation within a Veteran primary care sample. *Journal of General Internal Medicine, 31*, 1206–1211.
|
|
358
|
+
- **Scoring:** count of "yes" answers to the five symptom items, 0–5, recall window one month. The form's lead question on lifetime trauma exposure is not scored.
|
|
359
|
+
- **How the exposure gate is represented.** On paper the form asks "Have you ever experienced this kind of event?" and then says "If no, screen total = 0. Please stop here. If yes, please answer the questions below." psytools has no conditional display, so the gate is modelled the way the CRAFFT analysis below works it out: the exposure question is a required, unscored question (`pc-ptsd-5-trauma`); the five symptom items are `optional`; the scoring is a `count` over the five symptom items only; the missing-data policy is `ignore`. A respondent who answers "no" and stops is scored 0, which is the VA's rule. What the model cannot do is enforce the gate: nothing stops a consumer showing the symptom items after a "no", or requires them after a "yes". `meta.renderingNote` says so next to the data. Show the symptom items only after a "yes".
|
|
360
|
+
- **Two rendering changes, both mechanical.** The form introduces the five symptom items with one lead-in, "In the past month, have you...", and prints each item as its continuation ("had nightmares about the event(s)..."). psytools has one instruction field and no section headings, so the lead-in is prepended to each item, giving self-contained questions ("In the past month, have you had nightmares about the event(s)..."); the item wording after the lead-in is unchanged and a test checks every item carries it. The six bulleted trauma examples are joined into one sentence, separated by semicolons, in `instructions`. The gate sentences stay with the exposure question, as on the form. The answer labels "YES" / "NO" are rendered "Yes" / "No".
|
|
361
|
+
- **No bands, following the PCL-5 precedent.** The VA reports that "a cut-point of 4 ideally balanced false negatives and false positives for the overall sample and for men," that for women the same cut-point "resulted in high numbers of false negatives," and that "clinicians should consider sample characteristics and screening purposes when selecting a cut-point." A cut-point the rights holder tells users to choose per setting is the same situation as the PCL-5's provisional range, so it is recorded in `meta.scoringNote` rather than encoded as a band. Apply your own cut-point over `score`.
|
|
362
|
+
- **A positive screen is not a diagnosis.** The VA writes that those screening positive "require further assessment," preferably with a structured interview, and names the bundled `pcl5` as the self-report follow-up.
|
|
363
|
+
|
|
364
|
+
## PHQ-4: Patient Health Questionnaire for Depression and Anxiety (`phq4`)
|
|
365
|
+
|
|
366
|
+
**License: Free.** The same Pfizer grant as the bundled PHQ-9, GAD-7 and PHQ-15, read from three places: the screener page lists the PHQ-4 and says "no permission is required to reproduce, translate, display or distribute them" (<https://www.phqscreeners.com/select-screener>); the form's own footer reads "No permission required to reproduce, translate, display or distribute"; and the PHQ instruction manual lists the PHQ-4 in its Table 1 and says "All of the measures included in Table 1 are in the public domain."
|
|
367
|
+
|
|
368
|
+
- **Citation:** Kroenke, K., Spitzer, R. L., Williams, J. B. W., & Löwe, B. (2009). An ultra-brief screening scale for anxiety and depression: The PHQ-4. *Psychosomatics, 50*(6), 613–621.
|
|
369
|
+
- **Item source:** Pfizer's own English PHQ-4 form, the file the screener page offers for "PHQ-4" / "English" (fetched 2026-11-21). Item order follows that form: the two GAD-2 items first, then the two PHQ-2 items. The wording matches the corresponding items of Pfizer's English GAD-7 and PHQ-9 forms word for word.
|
|
370
|
+
- **Scoring:** three scales over the same four answers, on the PHQ's 0–3 frequency scale: anxiety (GAD-2, items 1–2, 0–6), depression (PHQ-2, items 3–4, 0–6) and the total (0–12). The manual says of the two subscales that "the recommended cutpoints for each when used as screeners is a score of 3 or greater," and that such a score "should prompt administration of the full PHQ-9 and/or GAD-7, as well as a clinical interview." Both subscales are banded there.
|
|
371
|
+
- **The total has no bands, because they could not be verified.** Total-score categories of 0–2 normal, 3–5 mild, 6–8 moderate and 9–12 severe are reproduced widely and attributed to Kroenke et al. (2009). The PHQ manual does not give them, and the 2009 paper and the 2010 general-population validation (Löwe et al.) are both paywalled with no open copy, so the attribution could not be checked against either. This file only bundles cut-offs read from the rights holder or the validation paper, so the total ships as a score without bands. If your protocol uses those categories, apply them over the total's `score`.
|
|
372
|
+
- **Overlapping scales.** The `total` scale reuses the four items the two subscales already score. A consumer summing all three scales would count every answer twice; read the total from its own scale.
|
|
373
|
+
|
|
374
|
+
## PHQ-8: Patient Health Questionnaire-8 (`phq8`)
|
|
375
|
+
|
|
376
|
+
**License: Free.** The same Pfizer grant and the same three sources as the PHQ-4 above: the screener page lists the PHQ-8, each PHQ-8 form carries the "No permission required to reproduce, translate, display or distribute" footer, and the manual's Table 1 lists it among the public-domain measures.
|
|
377
|
+
|
|
378
|
+
- **Citation:** Kroenke, K., Strine, T. W., Spitzer, R. L., Williams, J. B. W., Berry, J. T., & Mokdad, A. H. (2009). The PHQ-8 as a measure of current depression in the general population. *Journal of Affective Disorders, 114*(1–3), 163–173.
|
|
379
|
+
- **Item source:** Pfizer's own PHQ-8 form, "English for Canada" (fetched 2026-11-21). The screener page offers PHQ-8 English forms only for Australia, Canada, Singapore and the UK, none labelled plain English. The Canada and Singapore forms are identical, and both match items 1–8 and the instruction line of Pfizer's English PHQ-9 form word for word, so this is the US wording without item 9. The UK form differs by one character (a full stop for the question mark in item 8); the Australian form is a reworded adaptation.
|
|
380
|
+
- **Scoring:** sum 0–24 on the 0–3 frequency scale, past two weeks. The manual states "The PHQ-8 is scored just like the PHQ-9 and its total score ranges from 0 to 24. Cutpoints on the PHQ-8 are identical to the PHQ-9." The bands are therefore the PHQ-9's (5 mild, 10 moderate, 15 moderately severe, 20 severe), with the top band capped at 24. A score of 10 or more, the start of the moderate band, is the manual's "yellow flag" and the usual cut-point for current depression.
|
|
381
|
+
- **No self-harm item, so no flag.** The manual describes the PHQ-8 as "mainly used in non-depression research studies." Without item 9 it raises no `suicidality` flag. Do not use it where self-harm needs to be screened; use `phq9`.
|
|
382
|
+
|
|
383
|
+
## GDS-15: Geriatric Depression Scale, short form (`gds15`)
|
|
384
|
+
|
|
385
|
+
**License: Free.** The authors' page states: "The original scale is in the public domain due to it being partly the result of Federal support" (J. A. Yesavage, <https://web.stanford.edu/~yesavage/GDS.html>). The same page links the short form under "Original English Forms", offers it free in the authors' own apps, and invites anyone to submit translations for posting.
|
|
386
|
+
|
|
387
|
+
**How that statement is read for the short form.** "The original scale" could mean the original English text as opposed to the translations listed below it, or the original 30-item long form as opposed to the 15-item short form. The page itself supports the first reading: it files the short form under "Original English Forms", and nothing on the page treats the short form differently from the long form. The short form was developed by the same group (Sheikh and Yesavage, at Stanford and the VA Palo Alto). We read the statement as covering it, flag it `free`, and record the reading here so you can weigh it yourself.
|
|
388
|
+
|
|
389
|
+
- **Citation:** Sheikh, J. I., & Yesavage, J. A. (1986). Geriatric Depression Scale (GDS): Recent evidence and development of a shorter version. In *Clinical Gerontology: A Guide to Assessment and Intervention* (pp. 165–173). New York: The Haworth Press. Original scale: Yesavage, J. A., Brink, T. L., Rose, T. L., et al. (1983). Development and validation of a geriatric depression screening scale: A preliminary report. *Journal of Psychiatric Research, 17*, 37–49.
|
|
390
|
+
- **Item source:** the authors' "Short Form English" page (<https://web.stanford.edu/~yesavage/GDS.english.short.html>), fetched 2026-11-21. The page is headed "MOOD SCALE (short form)"; psytools titles it by the scale's published name instead.
|
|
391
|
+
- **Scoring:** 15 yes/no items about the past week, one point per answer in the depressive direction, total 0–15. The keys come from the authors' "Short Form English Scoring" page (<https://web.stanford.edu/~yesavage/GDS.english.short.score.html>), which prints the depressive answer in bold: "no" on items 1, 5, 7, 11 and 13, "yes" on the other ten. In psytools "Yes" stores 1 and "No" stores 0, and the five "no"-keyed items are `reverseScored`; a test pins the five.
|
|
392
|
+
- **Bands come from the authors' scoring page:** "for clinical purposes a score > 5 points is suggestive of depression and should warrent a follow-up interview. Scores > 10 are almost always depression." The bands split there: 0–5, 6–10, 11–15. The same sentence opens with "Although differing sensitivities and specificities have been obtained across studies," and the authors' main page calls the GDS "really a screening measure", so read the bands as the authors' clinical rule of thumb, not as a diagnosis.
|
|
393
|
+
- **Audience:** `audience: ["adult"]`. The scale is written and validated for older adults. psytools' audience vocabulary has no older-adult band, so it is filed with the adults and the title and description say what it is for.
|
|
394
|
+
|
|
395
|
+
## TIPI: Ten-Item Personality Inventory (`tipi`)
|
|
396
|
+
|
|
397
|
+
**License: Free.** The author's page says, in capitals: "Want to use the TIPI? Go ahead. Anyone can use it for any purpose. No need to ask me for permission." (S. D. Gosling, <https://gosling.psy.utexas.edu/scales-weve-developed/ten-item-personality-measure-tipi/>). There is no attribution condition and no commercial carve-out; like the IPIP grant, it is among the least conditional in this file.
|
|
398
|
+
|
|
399
|
+
- **Citation:** Gosling, S. D., Rentfrow, P. J., & Swann, W. B., Jr. (2003). A very brief measure of the Big-Five personality domains. *Journal of Research in Personality, 37*(6), 504–528.
|
|
400
|
+
- **Item source:** the authors' TIPI form PDF, linked as "TIPI scale (pdf)" from the page above (PDF dated 2003, fetched 2026-11-21). The form's lead-in "I see myself as:" closes the `instructions`, and the items keep the form's wording, including the trailing full stop. The form's instruction to "write a number next to each statement" is reproduced verbatim even though a screen will use a control instead, following the PCL-5 precedent.
|
|
401
|
+
- **Scoring:** five scales of two items each on the 1–7 agreement scale, one reverse-keyed item per scale: extraversion 1, 6R; agreeableness 2R, 7; conscientiousness 3, 8R; emotional stability 4R, 9; openness to experiences 5, 10R (the key printed on the form, matching the author's page: "The reverse scored items are 2, 4, 6, 8, & 10"). psytools reports scale **sums** (2–14); the author's published score is the **mean** of the two items, so divide by 2. Emotional stability is the reverse pole of the neuroticism scale the IPIP inventories report.
|
|
402
|
+
- **No bands.** No cutoffs exist. The author publishes norms (Gosling, Rentfrow & Potter, 2014, on the page above) for comparison instead.
|
|
403
|
+
- **Low internal consistency is by design.** The author asks users to read his note on alpha reliability before using the TIPI: with two broad items per scale, alpha and factor structure look weak, and he points to test-retest reliability as the better index. Treat single-scale scores as indicative, the same caution recorded for `ipip-via-r`.
|
|
404
|
+
|
|
252
405
|
## Instruments evaluated and not bundled
|
|
253
406
|
|
|
254
|
-
Instruments considered for inclusion and not shipped, each checked against the rights holder's own published terms. Recorded so the same ground is not covered twice.
|
|
407
|
+
Instruments considered for inclusion and not shipped, each checked against the rights holder's own published terms. Recorded so the same ground is not covered twice. Six entries come from a sweep of widely used ADHD instruments (July 2026) and one from the 2026-07 coverage wave; five are blocked by their licensing and two are waiting on a permission request.
|
|
255
408
|
|
|
256
409
|
- **ASRS v1.1, full 18-item Symptom Checklist** — © New York University and the President and Fellows of Harvard College. A separate product on the same NYU TOV platform from the 6-item screener, and the screener's free-commercial grant does not extend to it: clinical use is routed to a different site, research use requires an institutional signatory, and no commercial tier is offered. Not bundled.
|
|
257
410
|
- **ASRS-5 (DSM-5-aligned, 6 items)** — © New York University / NYU Langone Health. A different instrument from the v1.1 screener despite the similar name and length. Only a research-and-academic license is publicly offered, and the rights holder's own product listing calls the scoring rules proprietary. Not bundled.
|
|
@@ -259,5 +412,14 @@ Instruments considered for inclusion and not shipped, each checked against the r
|
|
|
259
412
|
- **SNAP-IV** — James M. Swanson / University of California, Irvine. Neither the instrument nor the developer's own published history of the scale carries a copyright or license statement at all. The absence of a grant is not a grant. Not bundled.
|
|
260
413
|
- **NICHQ Vanderbilt Assessment Scales (parent and teacher forms)** — © 2012 American Academy of Pediatrics, printed "All Rights Reserved" on the instrument. Free to download and administer, which is not the same as licensed to redistribute inside a package. Not bundled.
|
|
261
414
|
- **WFIRS-P / WFIRS-S (Weiss Functional Impairment Rating Scale)** — © Margaret Danielle Weiss, MD PhD. Permissive terms, but the notice asks that the author be contacted before translation. **Blocked on a permission request we intend to make, not on a refusal** — so this one may yet arrive.
|
|
415
|
+
- **CRAFFT 2.1 (adolescent substance-use screener)** — © John R. Knight, MD / Boston Children's Hospital, distributed by the Center for Adolescent Behavioral Health Research. Free of charge, warmly distributed, and it would have been the first non-adult instrument in the package. Held back on three grounds, any one of which is enough, all three read off the rights holder's own CRAFFT 2.1 Manual (version 28 October 2021):
|
|
416
|
+
|
|
417
|
+
1. **The permission we would need is the one that has not been asked for.** The manual grants clinicians permission-free use in their own practice "provided that questions are presented exactly as they appear in the copyrighted version," and then says plainly: "You do need to request approval to re-publish the CRAFFT in another print or electronic format. There is no fee for use or to request permission." Bundling the item text in a package *is* re-publishing it in another electronic format. That obligation lands on psytools at the moment we publish, not on the consumer at the moment they deploy — so it is not the kind of condition this file can pass downstream and let a reader apply to their own use. It is the same shape as the WFIRS entry above, and a degree stronger.
|
|
418
|
+
2. **Our translations would conflict with the condition attached to the grant.** Permission-free use is conditioned on questions appearing exactly as in the copyrighted version, and the rights holder maintains official translations in 27 languages — including all four psytools ships: Turkish, German, Chinese (Simplified) and Spanish. Shipping unverified AI translations next to that is not defensible, and it is a sharper conflict than the unresolved ASRS-6 translation question, where no official Turkish version exists to have used instead.
|
|
419
|
+
3. **Part A cannot be represented in this data model at all.** The CRAFFT's three opening questions ask on how many days in the past 12 months the respondent drank, used cannabis, or used anything else to get high, and the answer is a number written in a box. Every psytools question resolves to an enumerated option scale; there is no numeric-entry question type. Any enumerated scale we invented for Part A would be an answer format the instrument does not have — which independently breaks the "exactly as they appear" condition — and the earlier CRAFFT's yes/no opening questions are not a substitute, since 2.1 replaced them deliberately after finding they under-detected use.
|
|
420
|
+
|
|
421
|
+
**On the conditional structure specifically, since it is the interesting part and the next person should not have to re-derive it.** Part A gates Part B: if all three frequency answers are 0 the respondent is asked only the first Part B question (CAR, a riding-with-an-impaired-driver safety item asked of everyone), and otherwise all six. The score is the count of "yes" answers across Part B, 0–6, and 2 or more is the referral threshold. Two thirds of that *is* expressible declaratively — `count` scoring naming only the six Part B items, `optional: true` on the five that the gate can skip, and an `ignore` missing-data policy. That combination produces the right answer rather than a quietly wrong one: a respondent who reports no use is scored on the CAR item alone, giving 0 or 1, which is what the manual says their score is and is below the threshold either way. What it cannot do is *enforce* the gate — nothing in a declarative definition stops a consumer showing all six Part B items to a respondent who reported no use, or requires the other five when use is reported. So the honest summary is that the scoring survives the model and the administration logic does not.
|
|
422
|
+
|
|
423
|
+
**Blocked on a permission request, not on a refusal.** The ask is narrow and the manual says there is no fee for it: approval to re-publish the CRAFFT 2.1 English text inside an open-source package, and separately whether the official translations may be used in place of ours. Contact: <crafft@childrens.harvard.edu>. Until that comes back, `audience: ["adolescent"]` has no bundled instrument and the note in [target audience & respondent](#target-audience--respondent) above says so.
|
|
262
424
|
|
|
263
425
|
Hold rights to any of these, or know of a grant we missed? Please write to <samed@luckys.dev> — a correction here is as welcome as one to a bundled instrument.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { AssessmentDefinition } from "../types.ts";
|
|
2
|
+
/**
|
|
3
|
+
* CBI — Copenhagen Burnout Inventory (Kristensen, Borritz, Villadsen &
|
|
4
|
+
* Christensen, 2005).
|
|
5
|
+
*
|
|
6
|
+
* 19 items in three independent scales: personal burnout (6), work-related
|
|
7
|
+
* burnout (7), and client-related burnout (6). Each scale is scored on its
|
|
8
|
+
* own; there is no total across all 19, because the three ask about
|
|
9
|
+
* different attributions of the same exhaustion.
|
|
10
|
+
*
|
|
11
|
+
* Two response scales are mixed within the work and client scales — the
|
|
12
|
+
* degree scale on the items phrased as "is your work..." and the frequency
|
|
13
|
+
* scale on those phrased as "how often...". Both map to the same 100/75/50/
|
|
14
|
+
* 25/0 key, which is why the published score for each scale is the mean of
|
|
15
|
+
* its items on a 0–100 range. psytools reports subscale sums; divide by 6,
|
|
16
|
+
* 7, and 6 to get the published figure (the same convention the ECR-R, ERQ
|
|
17
|
+
* and HSPS entries follow).
|
|
18
|
+
*
|
|
19
|
+
* One item is reverse-keyed: work-burnout item 7, on having energy left for
|
|
20
|
+
* family and friends, where more energy means less burnout.
|
|
21
|
+
*
|
|
22
|
+
* No cutoffs are defined. The authors publish population norms (Danish
|
|
23
|
+
* means around 32 for personal burnout) rather than severity thresholds, so
|
|
24
|
+
* no bands are declared — see SOURCES.md.
|
|
25
|
+
*
|
|
26
|
+
* Item text is reproduced from the authors' own English first edition
|
|
27
|
+
* (February 2004), hosted by NFA, Denmark's National Research Centre for
|
|
28
|
+
* the Working Environment. Rights: no first-party grant exists — read the
|
|
29
|
+
* SOURCES.md entry before shipping this commercially.
|
|
30
|
+
*/
|
|
31
|
+
export declare const cbi: AssessmentDefinition;
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.cbi = void 0;
|
|
4
|
+
/** Always ... Never/almost never, scored 100 down to 0 (Kristensen et al.'s own key). */
|
|
5
|
+
const frequencyOptions = [
|
|
6
|
+
{ value: 100, label: { en: "Always" } },
|
|
7
|
+
{ value: 75, label: { en: "Often" } },
|
|
8
|
+
{ value: 50, label: { en: "Sometimes" } },
|
|
9
|
+
{ value: 25, label: { en: "Seldom" } },
|
|
10
|
+
{ value: 0, label: { en: "Never/almost never" } },
|
|
11
|
+
];
|
|
12
|
+
/** To a very high degree ... To a very low degree, scored on the same 100–0 key. */
|
|
13
|
+
const degreeOptions = [
|
|
14
|
+
{ value: 100, label: { en: "To a very high degree" } },
|
|
15
|
+
{ value: 75, label: { en: "To a high degree" } },
|
|
16
|
+
{ value: 50, label: { en: "Somewhat" } },
|
|
17
|
+
{ value: 25, label: { en: "To a low degree" } },
|
|
18
|
+
{ value: 0, label: { en: "To a very low degree" } },
|
|
19
|
+
];
|
|
20
|
+
/**
|
|
21
|
+
* CBI — Copenhagen Burnout Inventory (Kristensen, Borritz, Villadsen &
|
|
22
|
+
* Christensen, 2005).
|
|
23
|
+
*
|
|
24
|
+
* 19 items in three independent scales: personal burnout (6), work-related
|
|
25
|
+
* burnout (7), and client-related burnout (6). Each scale is scored on its
|
|
26
|
+
* own; there is no total across all 19, because the three ask about
|
|
27
|
+
* different attributions of the same exhaustion.
|
|
28
|
+
*
|
|
29
|
+
* Two response scales are mixed within the work and client scales — the
|
|
30
|
+
* degree scale on the items phrased as "is your work..." and the frequency
|
|
31
|
+
* scale on those phrased as "how often...". Both map to the same 100/75/50/
|
|
32
|
+
* 25/0 key, which is why the published score for each scale is the mean of
|
|
33
|
+
* its items on a 0–100 range. psytools reports subscale sums; divide by 6,
|
|
34
|
+
* 7, and 6 to get the published figure (the same convention the ECR-R, ERQ
|
|
35
|
+
* and HSPS entries follow).
|
|
36
|
+
*
|
|
37
|
+
* One item is reverse-keyed: work-burnout item 7, on having energy left for
|
|
38
|
+
* family and friends, where more energy means less burnout.
|
|
39
|
+
*
|
|
40
|
+
* No cutoffs are defined. The authors publish population norms (Danish
|
|
41
|
+
* means around 32 for personal burnout) rather than severity thresholds, so
|
|
42
|
+
* no bands are declared — see SOURCES.md.
|
|
43
|
+
*
|
|
44
|
+
* Item text is reproduced from the authors' own English first edition
|
|
45
|
+
* (February 2004), hosted by NFA, Denmark's National Research Centre for
|
|
46
|
+
* the Working Environment. Rights: no first-party grant exists — read the
|
|
47
|
+
* SOURCES.md entry before shipping this commercially.
|
|
48
|
+
*/
|
|
49
|
+
exports.cbi = {
|
|
50
|
+
id: "cbi",
|
|
51
|
+
version: "1.0.0",
|
|
52
|
+
categories: ["burnout"],
|
|
53
|
+
audience: ["adult"],
|
|
54
|
+
respondent: "self",
|
|
55
|
+
title: {
|
|
56
|
+
en: "Copenhagen Burnout Inventory (CBI)",
|
|
57
|
+
},
|
|
58
|
+
description: {
|
|
59
|
+
en: "A 19-item measure of burnout in three separately-scored scales: personal, work-related, and client-related exhaustion.",
|
|
60
|
+
},
|
|
61
|
+
instructions: {
|
|
62
|
+
en: "Choose the option that best describes you. Where the questions mention clients, read the word that fits your own work — patients, students, children, or whoever you work with. Answer the client questions only if your work involves them.",
|
|
63
|
+
},
|
|
64
|
+
defaultLocale: "en",
|
|
65
|
+
options: frequencyOptions,
|
|
66
|
+
questions: [
|
|
67
|
+
// Part one: personal burnout (frequency scale).
|
|
68
|
+
{ id: "cbi-1", text: { en: "How often do you feel tired?" } },
|
|
69
|
+
{ id: "cbi-2", text: { en: "How often are you physically exhausted?" } },
|
|
70
|
+
{ id: "cbi-3", text: { en: "How often are you emotionally exhausted?" } },
|
|
71
|
+
{ id: "cbi-4", text: { en: "How often do you think: “I can’t take it anymore”?" } },
|
|
72
|
+
{ id: "cbi-5", text: { en: "How often do you feel worn out?" } },
|
|
73
|
+
{ id: "cbi-6", text: { en: "How often do you feel weak and susceptible to illness?" } },
|
|
74
|
+
// Part two: work-related burnout (first three on the degree scale).
|
|
75
|
+
{ id: "cbi-7", text: { en: "Is your work emotionally exhausting?" }, options: degreeOptions },
|
|
76
|
+
{ id: "cbi-8", text: { en: "Do you feel burnt out because of your work?" }, options: degreeOptions },
|
|
77
|
+
{ id: "cbi-9", text: { en: "Does your work frustrate you?" }, options: degreeOptions },
|
|
78
|
+
{ id: "cbi-10", text: { en: "Do you feel worn out at the end of the working day?" } },
|
|
79
|
+
{ id: "cbi-11", text: { en: "Are you exhausted in the morning at the thought of another day at work?" } },
|
|
80
|
+
{ id: "cbi-12", text: { en: "Do you feel that every working hour is tiring for you?" } },
|
|
81
|
+
{ id: "cbi-13", text: { en: "Do you have enough energy for family and friends during leisure time?" }, reverseScored: true },
|
|
82
|
+
// Part three: client-related burnout (first four on the degree scale).
|
|
83
|
+
{ id: "cbi-14", text: { en: "Do you find it hard to work with clients?" }, options: degreeOptions },
|
|
84
|
+
{ id: "cbi-15", text: { en: "Do you find it frustrating to work with clients?" }, options: degreeOptions },
|
|
85
|
+
{ id: "cbi-16", text: { en: "Does it drain your energy to work with clients?" }, options: degreeOptions },
|
|
86
|
+
{ id: "cbi-17", text: { en: "Do you feel that you give more than you get back when you work with clients?" }, options: degreeOptions },
|
|
87
|
+
{ id: "cbi-18", text: { en: "Are you tired of working with clients?" } },
|
|
88
|
+
{ id: "cbi-19", text: { en: "Do you sometimes wonder how long you will be able to continue working with clients?" } },
|
|
89
|
+
],
|
|
90
|
+
scoring: {
|
|
91
|
+
kind: "subscales",
|
|
92
|
+
subscales: [
|
|
93
|
+
{
|
|
94
|
+
id: "personal",
|
|
95
|
+
label: { en: "Personal burnout" },
|
|
96
|
+
questionIds: ["cbi-1", "cbi-2", "cbi-3", "cbi-4", "cbi-5", "cbi-6"],
|
|
97
|
+
},
|
|
98
|
+
{
|
|
99
|
+
id: "work",
|
|
100
|
+
label: { en: "Work-related burnout" },
|
|
101
|
+
questionIds: ["cbi-7", "cbi-8", "cbi-9", "cbi-10", "cbi-11", "cbi-12", "cbi-13"],
|
|
102
|
+
},
|
|
103
|
+
{
|
|
104
|
+
id: "client",
|
|
105
|
+
label: { en: "Client-related burnout" },
|
|
106
|
+
questionIds: ["cbi-14", "cbi-15", "cbi-16", "cbi-17", "cbi-18", "cbi-19"],
|
|
107
|
+
},
|
|
108
|
+
],
|
|
109
|
+
missing: { strategy: "prorate", minAnswered: 4 },
|
|
110
|
+
},
|
|
111
|
+
meta: {
|
|
112
|
+
reference: "Kristensen, T. S., Borritz, M., Villadsen, E., & Christensen, K. B. (2005). The Copenhagen Burnout Inventory: A new tool for the assessment of burnout. Work & Stress, 19(3), 192-207.",
|
|
113
|
+
source: "Item text reproduced from the authors' own English first edition (February 2004), Marianne Borritz and Tage S. Kristensen, National Institute of Occupational Health, Copenhagen; hosted by NFA (Det Nationale Forskningscenter for Arbejdsmiljoe).",
|
|
114
|
+
license: "Free with conditions - no first-party grant exists. NFA, Denmark's national occupational-health research institute, hosts the complete instrument publicly with no gatekeeping, and an independent peer-reviewed validation study describes it as a public domain questionnaire; but neither the instrument nor any rights holder's own statement grants redistribution. See SOURCES.md for exactly what supports this and what is missing.",
|
|
115
|
+
licenseFlag: "free-with-conditions",
|
|
116
|
+
translationProvenance: "en: reproduced from the authors' own English edition. The instrument was developed in Danish for the PUMA study; the English text is the authors' own, not a third-party translation. Other locales (tr, de, zh, es): AI translation (Anthropic Claude, claude-opus-5) from that English; official translations were not consulted and the texts are unverified. See SOURCES.md.",
|
|
117
|
+
scoringNote: "Each scale is scored separately as the mean of its items on 0-100. psytools reports sums; divide by 6 (personal), 7 (work), and 6 (client).",
|
|
118
|
+
definitions: "Personal burnout: a state of prolonged physical and psychological exhaustion. Work-related burnout: the same, perceived as related to the person's work. Client-related burnout: the same, perceived as related to the person's work with clients.",
|
|
119
|
+
presentationNote: "The authors instruct that the items should not be presented in the printed order and may be interleaved with questions on other topics, to avoid stereotyped response patterns. psytools keeps the published order so the definition stays checkable against the source; shuffle at presentation time if you follow the recommendation.",
|
|
120
|
+
missingDataNote: "The authors' own rule classifies a respondent as a non-responder below 3 of 6 answered (personal), 4 of 7 (work), and 3 of 6 (client). A single policy cannot carry three thresholds, so minAnswered is pinned to 4 - stricter than the authors on the two 6-item scales, which fails safe by refusing to score rather than scoring thin data.",
|
|
121
|
+
},
|
|
122
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { AssessmentDefinition } from "../types.ts";
|
|
2
|
+
/**
|
|
3
|
+
* CSI-16 — Couples Satisfaction Index, 16-item version.
|
|
4
|
+
*
|
|
5
|
+
* 16 items on four different answer scales, total 0–81, higher is more
|
|
6
|
+
* satisfied; below 51.5 suggests notable dissatisfaction. Freely
|
|
7
|
+
* available for clinical and research use per the authors' own form;
|
|
8
|
+
* commercial use is not addressed either way — see SOURCES.md.
|
|
9
|
+
*/
|
|
10
|
+
export declare const csi16: AssessmentDefinition;
|