diff --git a/README.md b/README.md index 53dbd6b..ca6d257 100644 --- a/README.md +++ b/README.md @@ -37,37 +37,8 @@ People often select only a few events when explaining what happened. What drives └── plots ``` -### code - -Contains all code including the R code for analyzing data and generating figures, written in R. -See the rendered file here. - -### docs - -Contains all the experiment code. You can preview the experiments below: - -Condition "Hard Intervention / Positive Outcome": Click here! - -Condition "Hard Intervention / Negative Outcome": Click here! - -Condition "Soft Intervention / Positive Outcome": Click here! - -Condition "Soft Intervention / Negative Outcome": Click here! - -Condition "Fixed Intervention / Positive Outcome": Click here! - -Condition "Fixed Intervention / Negative Outcome": Click here! - - -### data - -Contains anonymized combined data for all experimental conditions (hard / soft / fixed intervention x positive / negative outcome) (for raw data and how these were computed, see code/R/). - -For example, fixedint_negative.csv contains the average percentage of choice selection (abnormal switch, normal switch, no preference) in the intervention and explanation task. - -data_int.csv combines all four dataframes (hardint_pos, hardint_neg, softint_pos, softint_neg, fixedint_pos, fixedint_neg) - ### code + This folder contains two types of R scripts. The model predictions can be seen here. The analyses and plots can be seen here @@ -94,71 +65,35 @@ The model predictions can be seen Click here! -### figures - -contains all the figures from the paper (generated using the script in code/R). - - -## General points - -- for folder and file names: - + don't use white space in either folder or filenames, use an underscore "_" instead - + (almost always) use lower case only -- always use relative paths in your code - + for example, to save a figure from an R script inside the `code/R/` folder the path should be "../../figures/figure_name.pdf" -- keep your folder structure organized - + we recommend adhering to the folder structure in this repository - + more complex projects may have additional folders such as `videos/`, `papers/`, ... -- note: some of the folders are empty except for a `.keep` file - + the `.keep` file is just there to make sure that github includes the otherwise empty folder - + feel free to delete the `.keep` file once you've added another file to that folder -- each code subfolder has a readme file that should be updated with information about the code scripts -- use github issues to keep track of any larger decisions that we make along the way -- make sure to create a slack channel for each project, link up the github repository with the slack channel, and add the people working on the project to the github repo and slack channel -- see our lab wiki for more help: https://github.com/cicl-stanford/wiki/wiki - -## Repository structure +Condition "Hard Intervention / Negative Outcome": Click here! -``` -├── code -│   ├── R -│   ├── bash -│   ├── experiments -│   └── python -├── data -├── figures -├── papers -├── presentation -└── writeup -``` +Condition "Soft Intervention / Positive Outcome": Click here! -### code +Condition "Soft Intervention / Negative Outcome": Click here! -Put all your code here. Use a separate folder for scripts based on the programming language. +Condition "Fixed Intervention / Positive Outcome": Click here! -#### experiments +Condition "Fixed Intervention / Negative Outcome": Click here! -The experiments folder is for the online (or in lab) experiments. Each experiment should be in its own folder. When you run another experiment, make sure to create a new folder (so that we always know what an experiment looked like when it was run). In readme file for the experiments folder, provide a brief summary of each experiment. Also note down any additional information that may not be saved within each experiment (e.g. how much the payment was for MTurk participants). ### data -Put your raw data files here. Any data wrangling to that file should happen in your code scripts. - -### figures +Contains anonymized combined data for all experimental conditions (hard / soft / fixed intervention x positive / negative outcome) (for raw data and how these were computed, see code/R/). -Save all your figures here. You may want to include additional subfolder here such as `plots/`, `diagrams/` etc. +For example, fixedint_negative.csv contains the average percentage of choice selection (abnormal switch, normal switch, no preference) in the intervention and explanation task. -### papers +data_int.csv combines all four dataframes (hardint_pos, hardint_neg, softint_pos, softint_neg, fixedint_pos, fixedint_neg) -Put research papers here that are relevant for your project. -### presentation +### figures -Put your project presentation here (e.g. your keynote, powerpoint, google slides, or pdf file). +contains all the figures from the paper (generated using the script in code/R). -### writeup Put all your writing here. This folder structure is likely to expand for more complex projects. For example, you could add a subfolders like folders `journal/cognition/submission/`, `proceedings/cogsci/resubmission/` etc.