瀏覽代碼

add a brief readme outlining test data types

Kimberly Meechan 3 月之前
父節點
當前提交
d2987e9fd6
共有 1 個文件被更改,包括 10 次插入1 次删除
  1. 10 1
      README.md

+ 10 - 1
README.md

@@ -1,3 +1,12 @@
 # oscar-test-data
 
-Test data for OSCaR breeding scheme calculator.
+Test data for [OSCaR](https://github.com/neuroinformatics-unit/OSCaR) breeding scheme calculator.
+
+All test data is fake, but matches the structure and edge cases of real data from a PyRAT server.
+
+## Types of test data
+
+- `*.json`: JSON files of raw PyRAT api responses
+- `pyrat-api-*.csv`: Expected csv files output by `get_pyrat_data`
+- `pyrat-data-*.csv`: Input csv files to `standardise_pyrat_csv`
+- `standardised-data-*.csv`: Expected output csv files from `standardise_pyrat_csv`