matnwb icon indicating copy to clipboard operation
matnwb copied to clipboard

Add documentation

Open jonc125 opened this issue 7 years ago • 7 comments

It'd be really helpful to those like me trying to read & understand how the package works to have (Matlab-style) documentation for each class and function. Particularly with the common use of abbreviations for variable & function names, and the lack of comments, it's quite hard to follow the logic!

jonc125 avatar Nov 23 '17 16:11 jonc125

I am also currently trying to implement MatNWB, I want to get my data into this format, but some documentation/tutorial would be super-helpful! I've noticed the excellent documentation for pynwb, but does something like this exist for matnwb, or is it in the works? Thanks again for this amazing work!

GMCadode avatar Sep 07 '18 19:09 GMCadode

What type data are you working with?

On Fri, Sep 7, 2018, 12:49 PM GMCadode [email protected] wrote:

I am also currently trying to implement MatNWB, I want to get my data into this format, but some documentation/tutorial would be super-helpful! I've noticed the excellent documentation for pynwb, but does something like this exist for matnwb, or is it in the works? Thanks again for this amazing work!

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/NeurodataWithoutBorders/matnwb/issues/1#issuecomment-419547654, or mute the thread https://github.com/notifications/unsubscribe-auth/AAziEoahGaVdT9qk7HS41tGEHiWIeKmxks5uYs3ggaJpZM4QpAqi .

bendichter avatar Sep 07 '18 19:09 bendichter

.mat files mostly, but I can potentially have things in other formats like .csv if necessary

GMCadode avatar Sep 09 '18 18:09 GMCadode

@gmcadode sorry I should have been more specific. Extracellular? Calcium imaging? What acquisition system?

bendichter avatar Sep 09 '18 19:09 bendichter

Oh, gotcha. I'm working with extracellular data, acquired from TDT's system 3 hardware. They have some functions to convert their data format into .mat though, so there's that.

GMCadode avatar Sep 10 '18 02:09 GMCadode

@GMCadode Check out https://github.com/bendichter/to_nwb/blob/master/to_nwb/chang/TDT2NWB.m, which converts TDT data to NWB and relies on TDTbin2mat.m. It handles raw LFP and analog (audio) data, but doesn't show you how to incorporate trials, derived data, extensions, etc. I agree we need better documentation but that should give you a good start.

bendichter avatar Sep 10 '18 03:09 bendichter

Thanks! I'll look thru it. Honestly I really believe in what NWB is about, so I'm looking forward to making it work in my lab!

GMCadode avatar Sep 10 '18 14:09 GMCadode