Selaa lähdekoodia

add README for analysis directory

George C. Privon 7 vuotta sitten
vanhempi
commit
b41fdf6eb4
2 muutettua tiedostoa jossa 27 lisäystä ja 0 poistoa
  1. 4 0
      CHANGELOG.md
  2. 23 0
      analysis/README.md

+ 4 - 0
CHANGELOG.md

@@ -4,6 +4,10 @@
 
 ### 0.4.1 (in progress)
 
+#### Enhancements
+
+* Add `analysis/README.md` file to briefly explain what the analysis scripts do.
+
 #### Bug fixes
 
 * Fixed bug where `ScoreProbByType.ipynb` sample script failed when showing PDFs for trade token score distributions.

+ 23 - 0
analysis/README.md

@@ -0,0 +1,23 @@
+# Analysis Script README
+
+This directory contains a selection of sample scripts to analyze game data.
+
+## Files
+
+* `CarcassonneScore-sample.db`: Sample database of game information
+
+### Working Scripts
+
+These scripts are [jupyter notebooks](https://jupyter.org/).
+
+* `Player-Multigame.ipynb`: Examine a single player's scoring behavior over multiple games.
+* `SampleAnalysis-SingleGame.ipynb`: Compare players within a single game.
+* `ScoreProbbyType.ipynb`: Take all game data and look at the distribution of points per score, separated by score type.
+
+### Placeholders
+
+These scripts are intended to be non-interactive versions of some of the above jupyter notebooks, but are not yet implemented.
+
+* `SingleGame-summary.py`
+* `SinglePlayer-summary.py`
+