Project title

An Ask-JGI data science support project from the Jean Golding Institute, University of Bristol.

Quick facts

Researcher
School / Faculty
Ask-JGI ticket
JGI contact
Language
Status

Overview

See PROJECT_SUMMARY.md for the full write-up.

Setup

R: in the project folder, run:

install.packages("renv")
renv::init()      # first time: records the packages you use in renv.lock
renv::restore()   # anyone else: installs the same package versions

Python: in the project folder, run:

python -m venv .venv
source .venv/bin/activate          # Windows: .venv\Scripts\activate
pip install -r requirements.txt    # create it with: pip freeze > requirements.txt

How to run

1. Put the researcher's data in data/raw/ (see Data below).
2. Run the scripts in code/ in number order (01_..., 02_..., ...).
3. Results appear in outputs/.

Folders

Folder	What goes in it
data/raw/	Original data from the researcher. Never edit these files.
data/processed/	Cleaned, analysis-ready data created by the code
code/	Scripts and notebooks, numbered in the order they run (01_clean.R, 02_model.py)
outputs/	Figures, tables and reports for the researcher
docs/	The original ticket, meeting notes, relevant papers

Data

Data is never committed to git. The .gitignore blocks everything in data/ and outputs/, plus common data file types.

• Where the data lives:
• Who can access it:
• What happens to it after the project: