Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
LaraKirfel authored Apr 25, 2024
1 parent 4fcb124 commit a25e16f
Showing 1 changed file with 14 additions and 79 deletions.
93 changes: 14 additions & 79 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://cicl-stanford.github.io/father-dont-forgive/">here</a>.

### docs

Contains all the experiment code. You can preview the experiments below:

Condition "Hard Intervention / Positive Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_1/index.html?condition=1">Click here!</a>

Condition "Hard Intervention / Negative Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_1/index.html?condition=3">Click here!</a>

Condition "Soft Intervention / Positive Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_2/index.html?condition=1">Click here!</a>

Condition "Soft Intervention / Negative Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_2/index.html?condition=3">Click here!</a>

Condition "Fixed Intervention / Positive Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_3/index.html?condition=1">Click here!</a>

Condition "Fixed Intervention / Negative Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_3/index.html?condition=3">Click here!</a>


### 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>code/R/</code>).

For example, <code>fixedint_negative.csv</code> contains the average percentage of choice selection (abnormal switch, normal switch, no preference) in the intervention and explanation task.

<code>data_int.csv</code> 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 <a href="https://cicl-stanford.github.io/explanation_intervention/analyses/experiments/index.html">here</a>. The analyses and plots can be seen <a href="https://cicl-stanford.github.io/explanation_intervention/analyses/models/index.html">here</a>

Expand All @@ -94,71 +65,35 @@ The model predictions can be seen <a href="https://cicl-stanford.github.io/expla
</li>
</ul>

### docs

Contains all the experiment code. You can preview the experiments below:

Condition "Hard Intervention / Positive Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_1/index.html?condition=1">Click here!</a>

### figures

contains all the figures from the paper (generated using the script in <code>code/R<code/>).


## 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": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_1/index.html?condition=3">Click here!</a>

```
├── code
│   ├── R
│   ├── bash
│   ├── experiments
│   └── python
├── data
├── figures
├── papers
├── presentation
└── writeup
```
Condition "Soft Intervention / Positive Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_2/index.html?condition=1">Click here!</a>

### code
Condition "Soft Intervention / Negative Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_2/index.html?condition=3">Click here!</a>

Put all your code here. Use a separate folder for scripts based on the programming language.
Condition "Fixed Intervention / Positive Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_3/index.html?condition=1">Click here!</a>

#### experiments
Condition "Fixed Intervention / Negative Outcome": <a href="https://cicl-stanford.github.io/explanation_intervention/experiment_3/index.html?condition=3">Click here!</a>

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>code/R/</code>).

Save all your figures here. You may want to include additional subfolder here such as `plots/`, `diagrams/` etc.
For example, <code>fixedint_negative.csv</code> contains the average percentage of choice selection (abnormal switch, normal switch, no preference) in the intervention and explanation task.

### papers
<code>data_int.csv</code> 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>code/R<code/>).

### 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.

0 comments on commit a25e16f

Please sign in to comment.