Merge 4368bc3 into 6e868f3

README.md

@@ -10,4 +10,13 @@ _**Topic:**_ [The Neural Basis of Loss Aversion in Decision Making Under Risk] (
 [SOME SUMMARY OF PAPER]
 
 ## Instructions
-[NEED TO ADD]
+
+- 'make clean' will delete extraneous files created by our scripts
+- 'make coverage' will check the coverage of our data, code directories 
+- 'make test' will run the tests in our code/utils/tests and code/data/tests directory
+- 'make verbose' is the verbose version of 'make test'
+
+
+
+
+[NEED TO ADD: instructions for data, scripts/analysis, paper (should be done in that order)]

code/README.md

@@ -0,0 +1,10 @@
+##CODE
+
+The code folder contains two subdirectories. Utils contains our functions for 
+analysis, our functions for graphing, and our tests. Scripts contains the 
+scripts that utilize these functions.
+
+Our makefile is written such that when run from the code directory:
+
+- 'make test' will run the tests inside utils/tests to check our functions
+- 'make coverage' will check the coverage of our functions

data/README.md

@@ -1,7 +1,8 @@
 The ds005 dataset, filtered ds005 dataset, and mni templates are stored here. Th
 e makefile is written such that:
 
-- `make data` will pull in the appropriate data 
+- `make data` will pull in the appropriate data. NOTE: ds005 will be 16.7 GB, so
+can take a while to download 
 - `make unzip` will unzip, remove, and rename certain files
 - `make validate` will run data.py to check the hashes of each downloaded file w
 ith a master hashlist included, ensuring all downloaded data is correct  

paper/README.md

@@ -0,0 +1,6 @@
+##Paper
+
+The makefile is written such that:
+
+- 'make all' will generate our paper in PDF format
+- 'make clean' will delete all extraneous files generated by 'make all'