rly / ndx-structured-behavior

An NWB extension for storing structured behavior programs and data, such as from BAABL/BEADL
BSD 3-Clause "New" or "Revised" License
3 stars 3 forks source link

TaskRecording #36

Closed mavaylon1 closed 11 months ago

mavaylon1 commented 11 months ago

This PR creates the ASE container to house the StatesTable, ActionsTable, and EventsTable.

mavaylon1 commented 11 months ago

Fix #34

mavaylon1 commented 11 months ago

This is not ready for a review. @oruebel Take a look and let me know if there is anything else you were thinking of. @rly I will dig a little deeper with breakpoint but when I do a roundtrip test it says that events, actions, and states don't have a parent. I checked the instance of ASE in my test and it does not have children. From my understanding the fields with the child key should've done that. I just wanted this out there as I dig around.

mavaylon1 commented 11 months ago

@oruebel I did a pass through the tests, the new code, and the schema. There is no changelog and we don't have a tutorial besides a user day demo.

oruebel commented 11 months ago

There is no changelog

I would start adding changelog information here https://github.com/rly/ndx-beadl/blob/main/docs/source/release_notes.rst

oruebel commented 11 months ago

Can you please update the notebook to use the new TaskRecording module

https://github.com/rly/ndx-beadl/blob/main/docs/tutorial_nwb_userdays_2022/beadl_example_nwb_userdays_2022.ipynb

If you want, we can also rename the tutorial tutorial_nwb_userdays_2022 folder to just notebooks or tutorial

mavaylon1 commented 11 months ago

@oruebel I made sure to update the notebook with the image from the paper. I also went through and renamed "ndx-beadl" to "ndx-Structured_Behavior" in the tutorial. I also took note of from the other PR (duration column) to where the create_extension_spec has been updated so that it is not a manual update on the schema itself. The first "log" is in the release_notes now.