Metadata-Version: 2.1
Name: itssutils
Version: 0.0.1
Summary: Utilities for analyzing Illinois Traffic Stop Study data.
Home-page: http://github.com/JustDSOrg/itssutils
Author: Chris Kucharczyk
Author-email: chris.kucharczyk@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: pandas
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: tqdm
Requires-Dist: statsmodels

# itssutils
### Illinois Traffic Stops Statistical Study Utilities

This package provides a way to calculate metrics for police traffic stops in Illinois. 
Built for use with data provided from the Illinois Traffic Stop Study.

Check out the [Illinois traffic stops website](https://illinoistrafficstops.com/) to learn more.

## Installation
You can install with `pip`:

`pip install itssutils`

## Usage

Download raw data [from this link](https://www.dropbox.com/sh/u2qq21gib0py19k/AAB4_7fKHjDBWZ2V_2mGH3_ca?dl=0) 
(you can download pre-processed metrics files there as well).

Process the raw data using the `RawITSSData` class.

```
from itssutils.itssdata import RawITSSData
raw = RawITSSData()
raw.load_single_year(2017, '2017_ITSS_Data.txt')
```

You can calculate metrics using the `ITSSMetrics` class.

```
from itssutils.itssdata import ITSSMetrics
met = ITSSMetrics(raw)
met.calculate_metics(['AgencyName', 'DriverRace'])
```

## Getting Started

Try opening up the [getting started notebook](notebooks/getting-started-2017.ipynb) 
and working your way through it to see what the package can do. Be sure to note any issues!

Look for more documentationon the [GitHub Pages site](https://justdsorg.github.io/itssutils/). 

