Skip to content

Commit 4b5d851

Browse files
jeremymanningclaude
andcommitted
Update README and docs with regenerated plots and modern API
- Regenerate all example plots using CMR dataset - Update README code examples to use modern egg.analyze() API - Add Murdock (1962) analysis plot to docs index page - Update code snippets to use correct listgroup syntax 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent e153467 commit 4b5d851

14 files changed

Lines changed: 27 additions & 24 deletions

README.md

Lines changed: 23 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -161,50 +161,53 @@ egg = quail.Egg(pres=presented_words, rec=recalled_words)
161161

162162
<h2>Analyze some data</h2>
163163

164-
```
165-
#load data
166-
egg = quail.load_example_data()
164+
```python
165+
# Load example data (CMR dataset)
166+
egg = quail.load_example_data('cmr')
167+
168+
# Create listgroup for averaging across lists
169+
listgroup = ['average'] * egg.n_lists
167170

168-
#analysis
169-
analyzed_data = quail.analyze(egg, analysis='accuracy', listgroup=['average']*8)
171+
# Analyze accuracy
172+
analyzed_data = egg.analyze('accuracy', listgroup=listgroup)
170173
```
171174

172175
<h2>Plot Accuracy</h2>
173176

174-
```
175-
analyzed_data = quail.analyze(egg, analysis='accuracy', listgroup=['average']*8)
176-
ax = quail.plot(analyzed_data, title='Recall Accuracy')
177+
```python
178+
analyzed_data = egg.analyze('accuracy', listgroup=listgroup)
179+
analyzed_data.plot(title='Recall Accuracy')
177180
```
178181
![Plot Accuracy](images/plot_acc.png)
179182

180183
<h2>Plot Serial Position Curve</h2>
181184

182-
```
183-
analyzed_data = quail.analyze(egg, analysis='spc', listgroup=['average']*8)
184-
ax = quail.plot(analyzed_data, title='Serial Position Curve')
185+
```python
186+
analyzed_data = egg.analyze('spc', listgroup=listgroup)
187+
analyzed_data.plot(title='Serial Position Curve')
185188
```
186189
![Plot SPC](images/plot_spc.png)
187190

188191
<h2>Plot Probability of First Recall</h2>
189192

190-
```
191-
analyzed_data = quail.analyze(egg, analysis='pfr', listgroup=['average']*8)
192-
ax = quail.plot(analyzed_data, title='Probability of First Recall')
193+
```python
194+
analyzed_data = egg.analyze('pfr', listgroup=listgroup)
195+
analyzed_data.plot(title='Probability of First Recall')
193196
```
194197
![Plot PFR](images/plot_pfr.png)
195198

196199
<h2>Plot Lag-CRP</h2>
197200

198-
```
199-
analyzed_data = quail.analyze(egg, analysis='lagcrp', listgroup=['average']*8)
200-
ax = quail.plot(analyzed_data, title='Lag-CRP')
201+
```python
202+
analyzed_data = egg.analyze('lagcrp', listgroup=listgroup)
203+
analyzed_data.plot(title='Lag-CRP')
201204
```
202205
![Plot Lag-CRP](images/plot_lagcrp.png)
203206

204207
<h2>Plot Memory Fingerprint</h2>
205208

206-
```
207-
analyzed_data = quail.analyze(egg, analysis='fingerprint', listgroup=['average']*8)
208-
ax = quail.plot(analyzed_data, title='Memory Fingerprint')
209+
```python
210+
analyzed_data = egg.analyze('fingerprint', features=['task', 'temporal'], listgroup=listgroup)
211+
analyzed_data.plot(title='Memory Fingerprint')
209212
```
210213
![Plot Fingerprint](images/plot_fingerprint.png)
355 KB
Loading

docs/_static/plot_acc.png

-19.8 KB
Loading

docs/_static/plot_fingerprint.png

21.6 KB
Loading

docs/_static/plot_lagcrp.png

26.7 KB
Loading

docs/_static/plot_pfr.png

-41 KB
Loading

docs/_static/plot_spc.png

-10.6 KB
Loading

docs/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
**Quail**: A python toolbox for analyzing free recall experiments and plotting the results
77
====================================================================================================
88

9-
.. image:: _static/plot_lagcrp.png
10-
:width: 400pt
11-
.. image:: _static/plot_fingerprint.png
12-
:width: 400pt
9+
.. image:: _static/murdock_1962_analysis.png
10+
:width: 800pt
11+
:align: center
12+
:alt: Murdock (1962) Free Recall Analysis
1313

1414
`Quail <https://github.com/ContextLab/quail>`_ is a library for analyzing and visualizing free recall data
1515
in Python. It is built on top of matplotlib and seaborn. For sample Jupyter

images/murdock_1962_analysis.png

355 KB
Loading

images/plot_acc.png

7.58 KB
Loading

0 commit comments

Comments
 (0)