Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
jerlich committed Jun 29, 2018
1 parent 3ded839 commit e35aa58
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 9 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.*
11 changes: 8 additions & 3 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,17 @@ Copyright © [2018] New York University and NYU Shanghai.

All Rights Reserved. A license to use and copy this software and its documentation solely for your internal non-commercial research purposes, without fee, is hereby granted upon your download of the software, through which you agree to the following: 1)  the above copyright notice, this paragraph and the following three paragraphs will prominently appear in all internal copies and modifications; 2)  no rights to sublicense or further distribute this software are granted; 3) no rights to modify this software are granted; and 4) no rights to assign this license are granted.   Please Contact The Office of Industrial Liaison, New York University, One Park Avenue, 6th Floor, New York, NY 10016 (212) 263-8178, for commercial licensing opportunities, or for further distribution, modification or license rights.

Created by [insert names of creators].
Created by Evgeniya Lukinova & Jeffrey Erlich.

IN NO EVENT SHALL NYU, OR ITS EMPLOYEES, OFFICERS, AGENTS OR TRUSTEES (“COLLECTIVELY “NYU PARTIES”) BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY KIND , INCLUDING LOST PROFITS, ARISING OUT OF ANY CLAIM RESULTING FROM YOUR USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF ANY OF NYU PARTIES HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH CLAIM OR DAMAGE.

NYU SPECIFICALLY DISCLAIMS ANY WARRANTIES OF ANY KIND REGARDING THE SOFTWARE, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, THE IMPLIED WARRANTIES OF  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, OR THE ACCURACY OR USEFULNESS, OR COMPLETENESS OF THE SOFTWARE. THE SOFTWARE AND ACCOMPANYING DOCUMENTATION, IF ANY, PROVIDED HEREUNDER IS PROVIDED COMPLETELY "AS IS". REGENTS HAS NO OBLIGATION TO PROVIDE FURTHER DOCUMENTATION, MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Please cite [    publication   ] if you use [ name of data ] in your research.
Please cite

Time preferences are reliable across time-horizons and verbal vs. experiential tasks
Evgeniya Lukinova, Yuyue Wang, Steven F. Lehrer, Jeffrey C. Erlich
bioRxiv 351312; doi: https://doi.org/10.1101/351312

if you use any code or data from this repository in your research.

[citation/reference for data]
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,8 @@ The `src` folder contains the code to run the tasks (in `task`) and also code th

## data

The `data` folder contains anonymized choice data from our subjects. For privacy considerations, we cannot not publicly share individual choice data. Please contact
The `data` folder contains anonymized choice data from our subjects. For privacy considerations, we cannot not publicly share individual choice data. Please contact

## media

The media contains movies demonstrating the tasks.
8 changes: 6 additions & 2 deletions data/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,9 @@

This folder contains `.mat` files that are required for generating the figures and tables in the paper.

File | Description
----- |------------
File | Description
----- |------------
delay3ways.mat | Individual choices
posterior_delay3ways.mat | results from [brms](https://github.com/paul-buerkner/brms) fits

TODO: Include a CSV version of delay3ways.mat for R code for the hierachical Bayesian model.
7 changes: 7 additions & 0 deletions media/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
| File | Description |
|------ |-------------|
| Learning_full.mov | A video showing all the learning stages |
| Learning.mov | A video showing clips of the learning stages |
| LV.mov | A video of the long-verbal task |
| NV.mov | A video of the non-verbal task |
| SV.mov | A video of the short-verbal task |
12 changes: 9 additions & 3 deletions src/analysis/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
### Master script to create figures
- 'master.m'

- `master.m`. Run this function to generate all the figures.

### MLE fitting
- 'fit_discount_loo.m': fmincon -> one can define several utility forms: hyperbolic, exponential, with curvature or not - and choose between two decision rules: softmax and matching, including leave one out cross validation
Necessary functions for the fits: 'discountf.m' - defines utility depending on the specified model, 'softmax.m' - sofmax decision rule, 'matchrule.m' - matching decision rule

- `fit_discount_loo.m`: fmincon -> one can define several utility forms: hyperbolic, exponential, with curvature or not - and choose between two decision rules: softmax and matching, including leave one out cross validation
- Necessary functions for the fits: `discountf.m` - defines utility depending on the specified model, `softmax.m` - sofmax decision rule, `matchrule.m` - matching decision rule

### TODO

Include the R code for the hierarchical Bayesian model.

0 comments on commit e35aa58

Please sign in to comment.