Skip to content

Commit

Permalink
Add terminology section to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iaindillingham committed Apr 25, 2022
1 parent 093809d commit ad569a2
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,19 @@ generate_deciles_charts:
| `tables.output` | Generate a deciles table for each measure table that is matched by the `--input-files` glob pattern |
| `charts.output` | Generate a deciles chart for each measure table that is matched by the `--input-files` glob pattern |

## Terminology

**Measure table**<br>
Generated by cohort-extractor's `generate_measures` function;
contains data for one measure for *all* index dates in a range
(a *partial* measure table contains data for one measure for *one* index date in a range)

**Deciles table**<br>
Derived from a measures table

**Deciles chart**<br>
Derived from a deciles table

## Notes for developers

Please see [_DEVELOPERS.md_](DEVELOPERS.md).
Expand Down

0 comments on commit ad569a2

Please sign in to comment.