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

Add example usage code in README #11

Closed rly closed 1 year ago

rly commented 2 years ago

The README file needs to be updated with example code demonstrating how to use the extension for a common use case.

Secondly, we should copy the example usage code into a unit test to ensure that the code works correctly even when the extension source code changes.

mavaylon1 commented 1 year ago

@rly can't they refer to the notebook?

oruebel commented 1 year ago

I think the example in the README serves a different purpose than the notebook. The example in the readme should be short and sweat, just showing how simple it is to use the extension and what it can do. The notebook then goes into much more detail to do a step-by-step walkthrough.

rly commented 1 year ago

I agree with @oruebel . Something like https://github.com/rly/ndx-events and https://github.com/rly/ndx-csd and https://github.com/catalystneuro/ndx-sound

mavaylon1 commented 1 year ago

20