Skip to content

About

Repository for BehaviorDEPOT pipeline app files and source code

Resources

Stars

44 stars

Watchers

3 watching

Forks

Repository files navigation

BehaviorDEPOT

BehaviorDEPOT is an open-source MATLAB toolbox for preparing rodent pose-estimation data, classifying behavioral bouts, and analyzing spatial and temporal behavior measures from DeepLabCut or SLEAP tracking output.

Install · Documentation · Demo data · Paper

Install

  1. Download BehaviorDEPOT_v1_7.mltbx from the latest release.
  2. In MATLAB, double-click the downloaded .mltbx, or choose Home > Add-Ons > Install from File.
  3. Open the Apps tab and select BehaviorDEPOTv1.7.

See the Wiki for installation details, input preparation, the Analysis Module, and outputs.

Requirements and compatibility

BehaviorDEPOT v1.7 requires MATLAB and:

  • Signal Processing Toolbox
  • Curve Fitting Toolbox
  • Image Processing Toolbox
  • Statistics and Machine Learning Toolbox

The Parallel Computing Toolbox is optional. BehaviorDEPOT v1.7 is compatible with MATLAB R2022b through R2026a Update 3 and has been tested on Windows 11 across that range.

Start here

Version 1.7

v1.7 adds persistent tracked-part registration defaults, redesigned tracked part and ROI workflows, validated batch input handling, and improved output and settings behavior. See What's New in v1.7 and the complete v1.7 changelog.

Demo data and models

The repository includes tracking files and selected analysis outputs under demo/. Download the associated source videos from the demo-data archive. Sample DeepLabCut models are available from the model archive.

Customize or build from source

The installer is intended for end users. For customization or to build a new toolbox release, clone this repository and work from:

Behavior classifiers and supporting runtime code are under code/. See Customization for guidance. Do not edit the MATLAB-managed installed add-on.

Citation

Gabriel CJ, Zeidler Z, Jin B, Guo C, Goodpaster CM, Kashay AQ, Wu A, Delaney M, Cheung J, DiFazio LE, Sharpe MJ, Aharoni D, Wilke SA, DeNardo LA. 2022. BehaviorDEPOT is a simple, flexible tool for automated behavioral detection based on markerless pose tracking. eLife 11:e74314. https://doi.org/10.7554/eLife.74314

License

BehaviorDEPOT is released under the GNU General Public License v3.0.

About

Repository for BehaviorDEPOT pipeline app files and source code

Resources

Stars

44 stars

Watchers

3 watching

Forks

Releases

Packages

Contributors

Languages