API reference

Egg class

quail.Egg([pres, rec, features, dist_funcs, ...])

Data object for the quail package

FriedEgg class

quail.FriedEgg([data, analysis, ...])

Object containing results of a quail analyses

Fingerprint class

quail.Fingerprint([init, features, state, ...])

Class for the memory fingerprint

Optimal Presenter class

quail.OptimalPresenter([strategy, features, ...])

A class that reorders stimuli to optimize memory performance

Load example data

quail.load_example_data([dataset])

Loads example data

Load egg

quail.load_egg(filepath[, update])

Loads pickled egg

Analyze

quail.analyze(egg[, subjgroup, listgroup, ...])

General analysis function that groups data by subject/list number and performs analysis.

Plot

quail.plot(results[, subjgroup, subjname, ...])

General plot function that groups data by subject/list number and performs analysis.

Decode speech

quail.decode_speech(path[, model_size, ...])

Decode speech for a file or folder and return results using OpenAI Whisper.

Stack eggs

quail.stack_eggs(eggs[, meta])

Takes a list of eggs, stacks them and reindexes the subject number

Crack egg

quail.crack_egg(egg[, subjects, lists])

Takes an egg and returns a subset of the subjects or lists

Convert recall matrix to egg

quail.recmat2egg(recmat[, list_length])

Creates egg data object from zero-indexed recall matrix