@decidables/detectable-elements 0.1.3 → 0.2.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.2.0](https://github.com/decidables/decidables/compare/@decidables/detectable-elements@0.1.3...@decidables/detectable-elements@0.2.0) (2022-04-07)
+
+
+### ⚠ BREAKING CHANGES
+
+* **detectable-elements:** "outcome" option now only colors outcomes, and "all" option colors everything
+
+### Features
+
+* **detectable-elements:** add equations for PPV and FOR ([9c7841c](https://github.com/decidables/decidables/commit/9c7841ceede9c553a9bfa0b6cfe685d65b8bdc03))
+* **detectable-elements:** add multiple value example ([407694a](https://github.com/decidables/decidables/commit/407694a884ead989ffeb1b1fd3dfa4436705d653))
+* **detectable-elements:** add new color option for table ([c0ea8ef](https://github.com/decidables/decidables/commit/c0ea8ef619816eb2f5d6ebcc0e64aefa9e871df7))
+* **detectable-elements:** use proper minus signs in labels ([bb4ec8c](https://github.com/decidables/decidables/commit/bb4ec8cf28465fa1ce452e5a77d459a4a04fd976))
+
+
+### Bug Fixes
+
+* **detectable-elements:** fix labelling and appeareance of incentives in detectable-response ([4b0b5a9](https://github.com/decidables/decidables/commit/4b0b5a9fc294672fc0610d5489231dbc6e363850))
+* **detectable-elements:** improve equation layout at small screen size ([e078034](https://github.com/decidables/decidables/commit/e07803402880ece793947d0dd4c87747b6ff7f06))
+
+
+
 ### [0.1.3](https://github.com/decidables/decidables/compare/@decidables/detectable-elements@0.1.2...@decidables/detectable-elements@0.1.3) (2022-03-31)
 
 

package/README.md

@@ -268,7 +268,9 @@ block of trials.
     - `'response'`
       - Color based on *'signal'* or *'noise'* response
     - `'outcome'`
-      - Color based on outcome of hit, miss, false alarm or correct rejection 
+      - Color based on outcome of *hit*, *miss*, *false alarm* or *correct rejection*
+    - `'all'`
+      - Color based on stimulus, response, and outcome
 - `zRoc: boolean = undefined`
   - Show a switch to set whether to use z-transformed ROC coordinates (`true`) or ROC coordinates
     (`false`)
@@ -592,13 +594,15 @@ overall results are optionally marginalized with accuracy.
     - `'none'`
       - No colors
     - `'accuracy'`
-      - Color based on accuracy, i.e. correct or error
+      - Color based on accuracy, i.e. *correct* or *error*
     - `'stimulus'`
-      - Color based on stimulus present or absent
+      - Color based on stimulus *present* or *absent*
     - `'response'`
-      - Color based on response 'present' or 'absent'
+      - Color based on response *'present'* or *'absent'*
     - `'outcome'`
-      - Full coloration based on hits, misses, false alarms and correct rejections
+      - Color based on *hits*, *misses*, *false alarms* and *correct rejections*
+    - `'all'`
+      - Color based on stimulus, response, and outcome
 - `hits: number = 40`
   - Number of hits
 - `misses: number = 60`
@@ -786,6 +790,44 @@ False alarm rate from false alarms and correct rejections
 <sdt-equation-facr2far numeric interactive false-alarms="25" correct-rejections="75"></sdt-equation-facr2far>
 ```
 
+#### `SDTEquationHFa2Ppv` / `<sdt-equation-hfa2ppv>`
+
+Positive predictive value rate from hits and false alarms
+
+##### Attributes
+
+- `numeric: boolean = false`
+  - Show values instead of just the names of variables
+- `interactive: boolean = false`
+  - Allow editing of numeric values in the equation
+- `hits: number = 0`
+  - Hits
+- `false-alarms: number = 0`
+  - False alarms
+
+##### Properties
+
+- `ppv: number`
+  - Positive predictive value
+
+##### Custom Events
+
+- `sdt-equation-hfa2ppv-change`
+  - Indicates that the values in the equation have changed
+  - `detail`
+    - `h: number`
+      - New value of hits
+    - `fa: number`
+      - New value of false alarms
+    - `hr: number`
+      - New value of positive predictive value
+
+##### Example
+
+```html
+<sdt-equation-hfa2ppv numeric interactive hits="75" false-alarms="25"></sdt-equation-hfa2ppv>
+```
+
 #### `SDTEquationHM2Hr` / `<sdt-equation-hm2hr>`
 
 Hit rate from hits and misses
@@ -954,6 +996,44 @@ Sensitivity from hit rate and false alarm rate
 <sdt-equation-hrfar2d numeric interactive unequal hit-rate="0.75" false-alarm-rate="0.25" s="1.5"></sdt-equation-hrfar2d>
 ```
 
+#### `SDTEquationMCr2Fomr` / `<sdt-equation-mcr2fomr>`
+
+Positive predictive value rate from hits and false alarms
+
+##### Attributes
+
+- `numeric: boolean = false`
+  - Show values instead of just the names of variables
+- `interactive: boolean = false`
+  - Allow editing of numeric values in the equation
+- `misses: number = 0`
+  - Misses
+- `correct-rejections: number = 0`
+  - Correct rejections
+
+##### Properties
+
+- `fomr: number`
+  - False omission rate
+
+##### Custom Events
+
+- `sdt-equation-mcr2fomr-change`
+  - Indicates that the values in the equation have changed
+  - `detail`
+    - `m: number`
+      - New value of misses
+    - `cr: number`
+      - New value of correct rejections
+    - `fomr: number`
+      - New value of false omission rate
+
+##### Example
+
+```html
+<sdt-equation-mcr2fomr numeric interactive misses="75" correct-rejections="25"></sdt-equation-mcr2fomr>
+```
+
 #### `SDTEquation`
 
 Base class for all interactive SDT equations
@@ -1118,6 +1198,49 @@ because their values are received from the model's task performance.
 </detectable-example-model>
 ```
 
+#### `DetectableExampleMultiple` / `<detectable-example-multiple>`
+
+Multiple value example
+
+Used to build specialized examples with multiple values for one variable (sensitivity or bias) and a
+single value for the other variable. Can include controls, ROC space, and a visual rendering of
+signal detection theory. The SDT model can be interactive.
+
+##### Attributes
+
+- `variable: string = 'd'`
+  - Choose which variable to have multiple values
+  - Options
+    - `'d'`
+      - Sensitivity
+    - `'c'`
+      - Bias
+- `values: Array = [0, 1]`
+  - Which marginals to display
+  - Expressed in HTML as a space-separated list of numbers
+
+##### Slots
+
+- *unnamed*
+  - Place relevant `detectable-elements` components here
+  - Wired elements
+    - `<detectable-control>`
+      - Allows user to adjust parameters
+    - `<sdt-model>`
+      - Display and change a visual rendering of sensitivity and bias
+    - `<roc-space>`
+      - Displays the hit rate and false alarm rate in ROC space
+
+##### Example
+
+```html
+<sdt-example-multiple variable="d" values="0 1 2 3 4">
+  <detectable-control z-roc></detectable-control>
+  <sdt-model interactive threshold bias></sdt-model>
+  <roc-space z-roc point="rest" iso-d="rest" iso-c="first"></roc-space>
+</sdt-example-multiple>
+```
+
 #### `DetectableExampleUnequal` / `<detectable-example-unequal>`
 
 Unequal variance example