Documentation for GRC Members

This is the documentation for GRC members working on the data analysis part of the project. It contains information on the best practices for version control, data analysis, and other useful tips.

Project Layout

.
├── config              # Configuration files
│
├── data                
│   ├── cleaned         # Cleaned output
│   ├── google          # Google Form API output (JSON)
│   ├── misc            # Miscellaneous data
│   └── raw             # Unprocessed data
│
├── docs                # Documentation
├── figures             # Figures for Final Report
│
├── src             
│   ├── api             # Code for interacting with APIs (i.e. Google Forms)
│   ├── models          # Schema definitions
│   ├── notebooks       # Jupyter notebooks
│   ├── R               # R scripts
│   ├── services        # Business logic
│   └── utils           # Utility functions
│
├── tests               # Unit tests
├── mkdocs.yml          # MkDocs configuration
├── poetry.lock         # Poetry lock file
├── pyproject.toml      # Poetry project file
└── README.md           # Project README

Getting Started

Prerequisites

Ensure you have Python 3.12 installed on your machine. You can download it from the official website.

Installation

1. Clone the repository

git clone https://github.com/UofT-FoM-GRC/Data_Analysis.git
cd Data_Analysis

1. Install the dependencies

poetry install

1. Activate the virtual environment

poetry shell

VSCode Extensions

• autoDocstring - Automatically generates Python docstrings.
• Better Comments - Improve your code commenting by annotating with alert, informational, TODOs, and more.
• Conventional Commits - A specification for adding human and machine
• Github Pull Requests and Issues - Pull request and issue functionality built into Visual Studio Code.
• Markdown All in One - All you need to write Markdown (keyboard shortcuts, table of contents, auto preview and more).
• Path Intellisense - Autocompletes filenames.
• Prettier - Code formatter - Code formatter using Prettier.
• Pylance - A new language server for Python.
• Python - Linting, debugging, Jupyter Notebooks, and more.
• Python Indent - Indentation for Python.
• R - R language support.
• R Debugger - R debugging support.
• Ruff - Python linting.
• YAML - YAML language support.

Previewing these docs

These docs are built using MkDocs. To preview these docs locally, you will need to install MkDocs and the Material theme.

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.