Skip to content

Commit 2f61235

Browse files
authored
Update README for v1.1
1 parent a8e05e7 commit 2f61235

File tree

1 file changed

+10
-28
lines changed

1 file changed

+10
-28
lines changed

README.md

Lines changed: 10 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,22 @@
11
# BehaviorDEPOT ReadME
22

3-
- BehaviorDEPOT v1.0 is now live and under initial testing! Please give it a try and let us know of any issues you may encounter.
3+
- BehaviorDEPOT v1.1 is now live! Please give it a try, and let us know of any issues you may encounter.
44

55
- To find out more about BehaviorDEPOT or to cite the software in your own paper, see our pre-print on bioRxiv: https://www.biorxiv.org/content/10.1101/2021.06.20.449150v2
66

77
- Demo data is now available that can be used to test installation, classifiers, spatial/temporal filtering, and modules. Due to limitations on file size, the original video file (necessary to run the analysis module from scratch) is not available on Github but can be downloaded from: https://drive.google.com/drive/folders/1VNv9FuXyiI4xgt-RokcVvWk-1dBovuqO?usp=sharing
88

99
- Sample DeepLabCut networks that have been trained on our data are available for use. These may work on your own data, depending on the individual camera/chamber setup, but these models can serve as starting points for quickly training your own new networks! Find them here: https://drive.google.com/drive/folders/1Fl4PmLz6CWQcqOjfQ1q_60ZCZjI5949-?usp=sharing
1010

11-
**Patch Notes v1.0**
12-
- Integrate pipeline with custom classifier selection
13-
- Update GUI design for support modules
14-
- Update GUI design for analysis module
15-
- Add readout of classifiers in GUI with interactive selectivity
16-
- Write function that runs the classifier functions using the info stored in P and the Params, Tracking, and Metrics structs
17-
- Add additional behavior classifiers
18-
- Re-work classifier files to use separate 'P_' files to store parameters
19-
- Write a function that can apply a minDuration threshold to selected Behavior data
20-
- Edit GUI to allow custom classifier usage
21-
- Add convertHumanAnnotations functionality to GUI
22-
- Update convertHumanAnnotations_BD code
23-
- Update Metrics structure; make more straightforward to add or modify metrics
24-
- Merge mainscript files
25-
- Add new metrics to calculateMetrics
26-
- Clean up metric naming in calculateMetrics
27-
- Update GUI to set [batch=0 or 1] to replace mainscript_single
28-
- Reformat rearing classifier
29-
- Reformat freezing classifier
30-
- Reformat moving classifier
31-
- Write function to standardize generation of behavior structures (genBehStruct)
32-
- Split freezing scripts into separate files (jitter and velocity)
33-
- Write function to detect start/stop inds (findStartStop)
34-
- Write function to apply min time threshold to behaviors (applyMinThreshold)
35-
- Add smoothing options to GUI
36-
- Add hampel filtering option to GUI
37-
- Update spatiotemporal filtering options
11+
**Patch Notes v1.1**
12+
- Updated mainscript to accomodate custom ROIs in classifiers
13+
- Added elevated plus maze (EPM) classifier
14+
- Added open field test (OFT) classifier
15+
- Added in-GUI button to open classifier folder
16+
- Adjusted spatial/temporal ROI output structure; collapsed Behavior_Filter into Behavior.Spatial and Behavior.Temporal
17+
- Minor bug fixes
18+
- Fixed a bug causing repeat analysis of single file on 'single' mode
19+
- Updated plotting files
3820

3921
**----------------------------------------------------------------------------------------------------**
4022

0 commit comments

Comments
 (0)