AllenNeuralDynamics / dynamic-foraging-task

Bonsai/Harp workflow for Dynamic Foraging with Python GUI for visualization and control
MIT License
5 stars 4 forks source link

Add reward delivery to dev #453

Closed ZhixiaoSu closed 2 months ago

ZhixiaoSu commented 2 months ago

The nwb file can be a bit misleading when the session has a 'reward delay', which is a fixed delay between response and reward.

In current version, 'reward_outome_time' is the time when reward is determined. If a choice is made, it's time of first lick, if not, it's time of end of lick window. It makes sense in sessions where there's no reward delay. But when we introduce a reward delay, this time should be called 'response_time' or 'decision_time' and additional 'reward_delay' information (not saved in nwb yet) should be added to calculate time of outcome.

Given how big impact this file may have downstream, minimum change is made here to enable analysis. One column called 'reward_delay' was added to NWB.

Btw, one questions about our current behavior pipeline: if we update the generate nwb function, do previous sessions get re-processed?

alexpiet commented 2 months ago

@ZhixiaoSu Why did you remove the formatting of the PR? (Sections like, testing, manual updates, what issues does this resolve, etc) That formatting is automatically parsed by my weekly email

ZhixiaoSu commented 2 months ago

@ZhixiaoSu Why did you remove the formatting of the PR? (Sections like, testing, manual updates, what issues does this resolve, etc) That formatting is automatically parsed by my weekly email

Sorry! I guess they were deleted when I scrolled down the pages on the laptop. Let me close this PR and redo a correct one.