Skip to content

jisanos/PR-Data-Correlations

Repository files navigation

P.R. Data Correlations

For our final project in CCOM6995/4995, we will explore if there is a positive correlation between crime statistics and unemployment.

This project provides a valuable opportunity for us to enhance our statistical skills, reinforce our understanding of the techniques learned in class, and apply them to a real-world scenario.

We will apply various techniques learned in class, such as p-value tests, confidence interval tests, and data cleaning and wrangling, to thoroughly examine this relationship.

Installation

We provide options for package management. Our manager of choice is Poetry, a modern environment and package installer for Python.

# Install the Poetry package manager for Python
make get-poetry

# Install our dependencies
make install

# Enter the virtual environment
poetry shell

If Poetry isn't your thing, that's fine! We also provide a requirements.txt file you can use:

make install-reqs

Contributing

All contributions from team members are welcome. However, some guidelines are in place to make sure the project stays clean and compliant with best practices.

Our coding style follows the Python Software Foundation's endorsed autoformatter, Black.

  • Install the automatic formatter by running poetry run pre-commit install.
  • Set up your editor to auto-format on save.
  • Avoid absolute paths in favor of relative paths when committing.
  • Commit any assets into the tree, but make sure your results are reproducible.
  • Inspect your code carefully.

Our formatter allows for standards compliance with minimal hassle. All your commits will be autoformatted after installation.

Folder structure

  • ./src: Contains scripts or notebooks
  • ./data/raw: Contains the unprocessed data
  • ./data/clean: Contains data after preprocessing/cleanup
  • ./results/visual: Contains visual analyses or representations

Data Sources

There are a number of datasets here which are not part of the final product. We analyzed them for exploration before choosing a final analysis subject. Here is the list of assigned topics converted into bold markdown items with links: