Updated the bicorder to permit a shortform based on analysis
This commit is contained in:
24
README.md
24
README.md
@@ -14,6 +14,8 @@ The bicorder consists of three components:
|
||||
* `diagnostic` composed of sets of gradients that measure the analyst's interpretation of the protocol
|
||||
* `analysis` that interprets the diagnostic data
|
||||
|
||||
A `shortform` option is available for a version of the bicorder that uses a smaller number of gradients. These are the gradients that, according to the [`analysis/`](analysis/), are the most salient and predictive of the values of other gradients.
|
||||
|
||||
### Metadata
|
||||
|
||||
There are several pieces of information that provide metadata about a given reading with the bicorder. More details about the data formats for each input are provided in `bicorder.schema.json`.
|
||||
@@ -22,6 +24,7 @@ There are several pieces of information that provide metadata about a given read
|
||||
* `analyst`: Name or other identifier of the analyst conducting the diagnostic
|
||||
* `standpoint`: Describe, even at some length, the relationship between the analyst and the protocol, including any relevant context that could affect the diagnostic readings
|
||||
* `timestamp`: A timestamp for when the reading occurred
|
||||
* `shortform`: Indicates whether the diagnostic was conducted using the abbreviated list of gradients
|
||||
|
||||
### Diagnostic
|
||||
|
||||
@@ -29,7 +32,11 @@ To carry out the diagnostic, the analyst should consider the protocol from the p
|
||||
|
||||
This is inevitably an interpretive exercise, but do your best to identify the most accurate `value`, with `1` being closest to `term_left` and `9` being closest to `term_right`.
|
||||
|
||||
Choosing a `value` in the middle, such as `5`, can mean "a bit of both" or "neither."
|
||||
Choosing a `value` in the middle, such as `5`, can mean "a bit of both." Leaving the gradient `value` as `null` means "not applicable."
|
||||
|
||||
There is a `notes` field for the analyst to add additional context or explanation.
|
||||
|
||||
The `shortform` boolean indicates whether this gradient is included in the abbreviated version of the bicorder.
|
||||
|
||||
### Analysis
|
||||
|
||||
@@ -72,11 +79,7 @@ To mark a gradient in a particular place, it is represented with a `#` like this
|
||||
|
||||
### Human-usable web app
|
||||
|
||||
* Create an online tool for reporting a protocol
|
||||
- Web app for fun that can be used with a mobile phone
|
||||
- Include tooltips for descriptions
|
||||
- Auto-analyze
|
||||
- Enable it to produce a JSON printout
|
||||
A progressive web app (PWA) for using the bicorder is located in [`bicorder-app/`](bicorder-app).
|
||||
|
||||
|
||||
## Synthetic data analysis
|
||||
@@ -87,15 +90,6 @@ See [`analysis/`](analysis/) for complete documentation and materials.
|
||||
|
||||
|
||||
<!---
|
||||
## To do
|
||||
|
||||
* Try data analysis
|
||||
* Continue iterating on the bicorder design
|
||||
* Develop the web app in a way that is tightly bound to the canonical JSON and schema
|
||||
* Fill out citations
|
||||
* Create script to output a book-friendly chart, utilizing ascii_bicorder but also adding descriptions and footnoted citations
|
||||
* Deploy to git.medlab.host
|
||||
|
||||
### Gradient citations
|
||||
|
||||
- implicit / explicit
|
||||
|
||||
Reference in New Issue
Block a user