Dirty Duck: A Guided Tour of Triage

THIS REPOSITORY HAS BEEN ARXIVED. DIRTYDUCK NOW IS PART OF TRIAGE. PLEASE GO TO HERE TO CONTINUE WITH THE SOURCE CODE OR HERE TO CONTINUE WITH THE TUTORIAL

Welcome!

This tutorial will show you how to use triage, a data science modeling tool developed at the Center for Data Science and Public Policy (DSaPP) at the University of Chicago.

triage helps build models for three common applied problems: (a) Early warning systems (EWS or EIS), (b) resource prioritization (a.k.a “an inspections problem”) and (c) interaction level predictions (a.k.a “appointment level”). These problems are difficult to model because their conceptualization and and implementation are prone to error, thanks to their multi-dimensional, multi-entity, time-series structure.

The last version of this tutorial is published in https://dssg.github.io/dirtyduck/

NOTE This tutorial is in sync with the latest version of triage. At this moment v3.3.0 (Arepa).

What you need for this tutorial

Install Docker CE and Docker Compose. That’s it. Follow the links for installation instructions.

Note that if you are using GNU/Linux you should add your user to the docker group following the instructions at this link.

At the moment only operative systems with *nix-type command lines are supported, such as GNU/Linux and MacOS. Recent versions of Windows may also work.

How to use this tutorial

First, clone this repository on your laptop

git clone https://github.com/dssg/dirtyduck.git

Second, run

./tutorial.sh start

This will take several minutes the first time you do it.

How you can help

Help is always welcome! You can report errors, improve the tutorial, or propose improvements to triage. These three cases are discussed below.

How to report errors

There are almost surely errors. Please open an issue and we will try to issue a fix as soon as possible.

How to improve the tutorial

This tutorial was created following the practices of Literate Programming using org-mode[fn:1] in GNU Emacs[fn:2]. That means the tutorial is a live document that mixes code and text.

The steps to help are:

clone the repository
edit the source org files in the org folder
From your terminal run

emacs  --batch -l org/publish.el org/index.org --eval '(org-publish "dirtyduck" t)'

create a pull request.

How to help develop `triage`

Go to the triage repository and follow the instructions there.

Footnotes

[fn:2] But it is supported in vim if you install a plugin.

[fn:1] It’s similar to markdown so you won’t have any problem.

rayidghani/dirtyduck