From 282bcb9603b30a2a47c5e663953903c8e60159c5 Mon Sep 17 00:00:00 2001 From: Riku Laine <riku.laine@helsinki.fi> Date: Mon, 12 Aug 2019 10:07:56 +0300 Subject: [PATCH] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 7ee237d..7a08e42 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,16 @@ Repository for the research project called *Causal approach to selective labels* with the required data sets. This repository has originally been forked from [the ProPublica repository for COMPAS analysis](https://github.com/propublica/compas-analysis). +## Structure of the repository + +The contents of the repository is divided into four main folders: +* `analysis_and_scripts` contains the scripts and notebooks for performing the analysis. Additionally, the +folder contains `notes.tex` file which contains much of the different research done. +* `data` folder contains the original data sets from the ProPublica analysis (see below for more information) +* `figures` contains the figures used for the notes file mentioned earlier. This +folder is also used for the figures for the BSocSc thesis. +* `paper` contains the draft for a research publication. + Original README: ``` Low High -- GitLab