Skip to main content

FiPhoPHA - A fiber photometry Python package for post-hoc analysis

Project description

FiPHoPHA - A Fiber Photometry Python Package for Post-Hoc Analysis

This Python tool allows for the analysis of photometry data, enabling the user to upload Excel files, select baseline and comparison periods, and calculate significant differences within and between-groups. The tool performs both bootstrapping to derive confidence intervals as well as permutation tests.

Cite (https://www.biorxiv.org/content/10.1101/2025.06.12.659422v1)

Features

  • Excel Integration: Load photometry data from Excel, analyze it, and save the results back to an Excel file.
  • Graphical User Interface (GUI): The application uses a simple GUI for file uploads, setting periods, and saving results.
  • Within and Between-Groups Bootstrapped Confidence Intervals (CI): Comparison to baseline is determined by whether the bootstrapped CI includes the null of 0. Whilst comparison for within-groups is determined from subtracting each corresponding animal/trial of the group and bootstrapping the product to derive CIs and determining deviation from the null of 0. For between-groups the distribution of each group is bootstrapped and subtracted, then CIs derived and determined if they deviate from the null of 0
  • Permutation Test: Permutation tests are used to compare differences between groups and determine significance.

How to Use

  1. Load Excel Data: Click the "Load Excel File" button to load your photometry data in .xlsx format.
  2. Set Baseline and Comparison Periods: Enter the row indices for the baseline and comparison periods.
  3. Analyze Data: The application will analyze the loaded data, calculating bootstrapped confidence intervals and performing permutation tests between groups.
  4. Save Results: Save the analyzed results to an Excel file, which includes confidence intervals, significance maps, and significant timings.

Excel File Structure

  • Sheets: Timings, where each row corresponds to a Z-score of that time point and columns represent individual animals/trials.
  • Subsequent Sheets represent different groups of animals

Installation Instructions in Any Environemnt

  1. Install package:
pip install fiphopha
  1. Run main script:
fiphopha

Dependencies

  • NumPy
  • Pandas
  • Scikit-learn
  • Tkinter
  • Setuptools
  • Openpyxl

Acknowledgements

Adapted from Dr. Philip Jean-Richard Dit Bressel from the University of New South Wales Jean-Richard-Dit-Bressel, P., Clifford, C. W. G., & McNally, G. P. (2020). Analyzing Event-Related Transients: Confidence Intervals, Permutation Tests, and Consecutive Thresholds. Frontiers in molecular neuroscience, 13, 14. https://doi.org/10.3389/fnmol.2020.00014

I would also like to thank all members of the Andrews Lab at Monash University for being testers of the scripts.

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

fiphopha-0.2.1.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

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

fiphopha-0.2.1-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file fiphopha-0.2.1.tar.gz.

File metadata

  • Download URL: fiphopha-0.2.1.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.6

File hashes

Hashes for fiphopha-0.2.1.tar.gz
Algorithm Hash digest
SHA256 1215c22256ca1aa51d81ce37b28fff68f13936546c2c65e39ec84b2ee7535c8a
MD5 4b0cef21d9c4f11c9ab61ad7960e30b5
BLAKE2b-256 ed27dec41604d01a505599ace3d7a9d38d1e5bb4ef2b747a94fbea43847751aa

See more details on using hashes here.

File details

Details for the file fiphopha-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: fiphopha-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.6

File hashes

Hashes for fiphopha-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 87cfaca70693b4c27184901cccaa20346bc6bf8a3b4090ca0e57e65af3343463
MD5 575c18ebdf29cdab1ef4b353b5fe898a
BLAKE2b-256 26f46d0059852fa7c76c8867a59ace6e534365597b73dce453e0eab0add671ea

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