Skip to content

Collection of notebooks and scripts to create/populate spyglass tables for analysis of ms optogenetic project

Notifications You must be signed in to change notification settings

LorenFrankLab/ms_stim_analysis

Repository files navigation

ms_stim_analysis

This repository accompanies the manuscript Disruption of theta-timescale spiking impairs learning but spares hippocampal replay (Joshi A, Comrie AE, Bray S, Mankili A, Guidera JA, et al., 2025).

It provides:

  • Ready-to-use scripts to process wideband data into LFP and spikes, and to perform spike sorting, clusterless decoding, and LFP analysis using Spyglass.

  • Tools to examine stimulus-driven entrainment and suppression, changes in pairwise correlations, spatial fields, theta sequences, replay, and learning.

  • Figure notebooks that reproduce the main and supplementary results.

Results demonstrate the effects of rhythmic and theta-phase-specific closed-loop optogenetic activation of medial septum parvalbumin-expressing neurons on hippocampal LFPs, spatiotemporal coding, and task learning.

Demo: Theta-phase-specific stimulation of medial septum PV neurons suppresses the rhythmicity of hippocampal ahead-behind sweeps of location during track traversal.

Transfected animal

Installation

To install the package with custom analysis tables and run the associated notebooks (recommended), follow these steps:

  1. Clone the repository to your local system.
  2. Navigate to the cloned directory and run: pip install .

Todo:

  • PyPI release

Usage

New work

If you want to apply the analysis pipelines to new datasets, you can install the package and use the custom tables together with your existing database and the spyglass ecosystem.

Reuse and Replication (Recommended!)

All raw data and derived results (e.g., spike sorting, LFP) are available through the DANDI archive

We have also released a docker images for easy access and use of this paper's results This includes:

  • a pre-built conda environment with all necessary packages
  • the notebooks from this repository, and
  • a populated SQL database with all information needed to query and retrieve results from the DANDI archive.

Docker Container instructions

  1. Install Docker on your local machine
  2. Download and unzip this directory
  3. Navigate to the unzipped directory in your terminal
  4. Run: docker compose -f docker-compose-collab.yml up -d
  5. In a web browser, navigate to localhost:8888/lab/tree/notebooks and log in with the password ms_stim_analysis

This will land you at a jupyter hub with the figure-generating notebooks for this project and access to a pre-populated instance of the spyglass database.

Associated repositories

  • non_local_detector: tools for clusterless decoding of hippocampal population activity.

  • spyglass: database framework for managing electrophysiology and behavioral data.

  • trodes: acquisition and stimulation software used in these experiments.

  • ndx-optogenetics: NWB extension for representing optogenetic stimulation protocols and metadata.

  • ndx-franklab-novela: Frank Lab–specific NWB extension for storing lab-specific data in NWB/DANDI.

Code Directory

Figure Panel Notebook
1 D opto_stimResponse_analysis.ipynb
E opto_powerSpectrum_analysis.ipynb
F opto_powerSpectrum_analysis.ipynb
G opto_stimResponse_analysis.ipynb
H opto_powerSpectrum_closedLoop_analysis.ipynb
I opto_powerSpectrum_closedLoop_analysis.ipynb
2 B opto_spiking_response.ipynb
C mua_response.ipynb
D peak_delay_timescales_lineartrack.ipynb
E Fig2E.ipynb
F place_field_table_plots.ipynb
G place_field_table_plots.ipynb
3 A learning_curves.ipynb
B learning_curves.ipynb
C learning_curves.ipynb
D learning_curves.ipynb
E outbound_error_repeats.ipynb
F choice_point_occupancy.ipynb
F speed_distributions.ipynb
4 A wtrack_examples_first_epoch.ipynb
B ahead_behind_spectrum.ipynb
C clusterless_decode_stim_response.ipynb
D clusterless_decode_stim_response.ipynb
E wtrack_examples_first_epoch.ipynb
F ahead_behind_spectrum.ipynb
G clusterless_decode_stim_response.ipynb
H clusterless_decode_stim_response.ipynb
I ahead_behind_spectrum.ipynb
5 A continuous_traversals.ipynb
A continuous_traversals_first_epoch.ipynb
B opto_ripple_analysis_difference.ipynb
C ripple_decodes.ipynb
D replay_decode_speed.ipynb
S1 * opto_powerSpectrum_analysis.ipynb
S2 A supplement_rose_plot.ipynb
B stim_field_interaction.ipynb
S3 A clusterless_decode_stim_response.ipynb
B peak_delay_timescales.ipynb
C peak_delay_timescales.ipynb
D peak_delay_timescales.ipynb
E peak_delay_timescales.ipynb
F place_field_table_plots.ipynb
G decoding_stim_max_ahead_behind_choice_point.ipynb
S4 * ahead_behind_spectrum.ipynb
Animal Alias Targeted
Winnie V 1
Frodo F 1
Totoro T 1
Banner B 1
Odins O 1
Wallie W 0
Olive L 0
Yoshi Y 0
Bilbo I 0

About

Collection of notebooks and scripts to create/populate spyglass tables for analysis of ms optogenetic project

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •