Skip to main content

Psifr: Analysis and visualization of free recall data

Project description

Psifr

PyPI version Documentation Status Pytest codecov status DOI

Advanced analysis and visualization of free recall data in Python.

Features:

  • A large library of advanced analyses, tested against published benchmarks
  • Flexible analysis customization and plotting
  • Tools for exploratory analysis of large datasets
  • Extensive automated testing to ensure analysis correctness
  • Based around a simple and flexible table-based data format
  • Comprehensive documentation and user guide

The name Psifr is pronounced "cipher". It's taken from Psi, in reference to the field of psychology, and FR for free recall.

free recall visualization
Raster plot showing each recall in a free recall experiment. Color indicates serial position; yellow items were presented late in the list, while purple items were presented at the beginning. Magenta squares indicate intrusions of items that were not presented during the study list.

Installation

You can install the latest stable version of Psifr using pip:

pip install psifr

You can also install the development version directly from the code repository on GitHub:

pip install git+https://github.com/mortonne/psifr

Quickstart

To plot a serial position curve for a sample dataset:

from psifr import fr
df = fr.sample_data('Morton2013')
data = fr.merge_free_recall(df)
recall = fr.spc(data)
g = fr.plot_spc(recall)

See the user guide for detailed documentation on importing and analyzing free recall datasets.

Also see the Jupyter notebooks for more analysis examples:

Importing data

Generally the best way to get your data into shape for analysis in Psifr is to create a CSV (or TSV) file with one row for each event in the experiment, including study events (i.e., item presentations) and all recall attempts (including repeats and intrusions). See importing data for details.

A number of archival free recall datasets are available in the Matlab-based EMBAM format. Data archives for a number of studies are available from the UPenn and Vanderbilt memory labs. If you have data in EMBAM format, use matlab/frdata2table.m to convert your data struct to a table with standard format. Then use the Matlab function writetable to write a CSV file which can then be read into Python for analysis.

Citation

If you use Psifr, please cite the paper:

Morton, N. W., (2020). Psifr: Analysis and visualization of free recall data. Journal of Open Source Software, 5(54), 2669, https://doi.org/10.21105/joss.02669

Publications using Psifr

Hong, B., Barense, M. D., Pace-Tonna, C. A. & Mack, M. L. (2022). Emphasizing associations from encoding affects free recall at retrieval. Proceedings of the Annual Meeting of the Cognitive Science Society 453–460. https://escholarship.org/uc/item/2gw1s36q

Related projects

EMBAM

Analyses supported by Psifr are based on analyses implemented in the Matlab toolbox EMBAM.

pybeh

pybeh is a direct Python port of EMBAM that supports a wide range of analyses.

Quail

Quail runs automatic scoring of free recall data, supports calculation and plotting of some common free recall measures, and has tools for measuring the "memory fingerprint" of individuals.

Contributing to Psifr

Contributions are welcome to suggest new features, add documentation, and identify bugs. See the contributing guidelines for an overview.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

psifr-0.10.1.tar.gz (5.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

psifr-0.10.1-py3-none-any.whl (5.8 MB view details)

Uploaded Python 3

File details

Details for the file psifr-0.10.1.tar.gz.

File metadata

  • Download URL: psifr-0.10.1.tar.gz
  • Upload date:
  • Size: 5.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for psifr-0.10.1.tar.gz
Algorithm Hash digest
SHA256 e7b4aeb1889e8f47a6f8a6fec4bc52b04c4541f6e27743392959774b8b309ff4
MD5 06a62ee46830d9aba8d142a7c4f45106
BLAKE2b-256 fe3702d02cce11a934f5024814e0064e49d5eb26502d14942a859edc7641a0b9

See more details on using hashes here.

File details

Details for the file psifr-0.10.1-py3-none-any.whl.

File metadata

  • Download URL: psifr-0.10.1-py3-none-any.whl
  • Upload date:
  • Size: 5.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for psifr-0.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cd22befa61d5d6cbcb3fef970d5c1f7eda5b9acd94618cac08095dc9a271f562
MD5 96187378e6ac7611a2feca947fbfcca9
BLAKE2b-256 d1d2f40f44465ef714a70715895cb1ae5ca5c6826133d5cbe091c1bb1ec49a45

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page