Skip to content

minor readme adjustments #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
celefthe merged 1 commit into from
Aug 11, 2026
Merged

minor readme adjustments #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Analysis library and CLI for behavioural session data recorded with [Visiomode](

## Features

- **Session summaries** — quickly summarise session stats, including signal detection theory metrics.
- **HTML reports** — standalone, self-contained session reports with embedded Plotly figures.
- **GLM regressors** — event regressors (stimulus/response/reward windows) aligned to an external timestamp series, such as imaging frame timestamps or electrophysiology acquisition rates.
- **Subject-level and cohort-level analysis** — combine per-session trial summaries into a single per-subject summary CSV, as well as group-level analysis across subjects.
- **Session summaries:** quickly summarise session stats, including signal detection theory metrics.
- **HTML reports:** standalone, self-contained session reports with embedded Plotly figures.
- **GLM regressors:** event regressors (stimulus/response/reward windows) aligned to an external timestamp series, such as imaging frame timestamps or electrophysiology acquisition rates.
- **Subject-level and cohort-level analysis:** combine per-session trial summaries into a single per-subject summary CSV, as well as group-level analysis across subjects.

## Installation

Expand Down Expand Up @@ -96,7 +96,7 @@ src/visiomode_analysis/
│ └── regressor.py # per-protocol GLM regressor construction
├── subject/ # collates per-session trials.csv files into a subject summary
│ └── __init__.py
├── group/ # cohort-level aggregation across subjects (stub, unimplemented)
├── group/ # cohort-level aggregation across subjects (not implemented yet)
│ └── __init__.py
└── reports/ # Jinja2 templates for HTML session reports
├── __init__.py
Expand All @@ -108,15 +108,9 @@ src/visiomode_analysis/
## Development

```bash
# Run the full test suite with coverage (matches CI)
# Run the full test suite with coverage
hatch test --cover

# Run tests directly with pytest (faster iteration)
.venv/bin/pytest

# Run a single test file / test
.venv/bin/pytest tests/test_metrics.py::test_d_prime_afc_correction -v

# Type checking
hatch run types:check
```
Expand Down
Loading