This repository contains the basic outline of an analysis repository that plans for our typical need to support many different languanges among all of our project partners.
When you start a new repository based on this one, you should replace this overview with an actual project overview and delete whatever requirements descriptions you do not need from the below.
To run the code in this repository, you will need Python 3.8+ and R 4.0.2+ pre-installed. We also require SPSS version 16.
In Python, we use poetry to manage our dependencies. In R, we use renv.
To install these dependency managers, you can run (assumes Mac or Linux; see tools' documentation for other operating systems):
curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3 -
Rscript -e 'if(!requireNamespace("renv")) { install.packages("renv") }'Once these are installed, you can install all dependencies with
poetry install
Rscript -e 'renv::restore()'In order to run some of this code, you will also need a Census API Key. Once you have the key, copy the .env.sample file to .env and fill in your API key in the specified location.
To replicate the final analysis, run make all.
Use this section to describe your code layout.
Several tests have been written in the tests folder. They may be run with poetry run py.test.
This repository outline has been tested mostly on Mac OS with Intel processors as well
as on some Windows machines of expert software engineers. There are known issues with
using poetry to install the GIS stack for Python on Mac M1 processors at this time.
If you'd like to help fix this issue, get in touch and perhaps we can collaborate to
solve the problem.
MIT