reading-analysis

This repo provides the analysis methods used in the Reading Analytics Group.

Installation

To obtain this repository, use the following command:

git clone git@github.com:reading-analytics-group/reading-analysis.git

Dependencies

For each subsection of scripts, documenting and installing dependencies is done via a requirements.txt. To install, use the following command:

pip install -r requirements.txt

Repo Structure

For the repo's structure, we separate the scripts and the data, to more easily version control the script's evolution. In the data folder, there is the datasets (for the raw collected data) and the processed_data which includes any intermediate pre-processing data stubs or final results. Avoid putting intermediate data inside datasets folder, unless you intend to share these to the team (which can be difficult to do).

Within the scripts folder, make sure to include your requirements.txt file to document and be explicit about your dependencies. Additionally, providing a README.md for each group of similar scripts is recommended.