Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation/Tutorial #200

Open
dlevenstein opened this issue May 19, 2018 · 27 comments
Open

Documentation/Tutorial #200

dlevenstein opened this issue May 19, 2018 · 27 comments

Comments

@dlevenstein
Copy link
Collaborator

dlevenstein commented May 19, 2018

We should have a tutorial script that uses the sample structures and shows the user how to use the basic I/O functions (LFP/spikes/sessionInfo, etc), and run a basic analysis.

@dlevenstein dlevenstein added this to the first 'stable' release milestone May 19, 2018
@dlevenstein dlevenstein self-assigned this May 19, 2018
@dlevenstein dlevenstein changed the title Documentation Documentation/Tutorial May 19, 2018
@brendonw1
Copy link
Collaborator

brendonw1 commented May 20, 2018 via email

@dlevenstein
Copy link
Collaborator Author

Another related thing that needs to be done is a function description list. Can be updated/improved as we add more functions to the repo.

Just putting this here for later notice to self or others.

@brendonw1
Copy link
Collaborator

What approximate format should this take? Maybe example problems experiments where people are walked through the relevant code?

@DavidTingley
Copy link
Collaborator

uploaded to dev branch. @raswanson can upload her tutorial, I'll work on one for ratemapping

@dlevenstein
Copy link
Collaborator Author

We just discussed this a bit. Sounds like Rachel actually made a quick tutorial for Omid and a visiting postdoc a few months ago. We're going to make a "tutorials" folder and put it in there and then we can expand it.

The thinking at this point was having a few tutorials - one basic that includes things like how to load lfp, spikes, sessionInfo. And then a few specialized ones with things like lfp-spike analyses or detection or detecting place fields.

@DavidTingley
Copy link
Collaborator

We should also update the Wiki to reflect this folder and its contents

@dlevenstein
Copy link
Collaborator Author

Jinx

@DavidTingley
Copy link
Collaborator

@brendonw1 @evilrobotxoxo Do you guys have any students that might make for good alpha testers for tutorial scripts that we put together?

@brendonw1
Copy link
Collaborator

Yeah I think so... we may try some place cell/field analysis. I assume that's a good direction to go for a pretty complete and yet basic analysis type?

@DavidTingley
Copy link
Collaborator

@brendonw1 let me know if this works for you guys, it's a quick tutorial on ratemapping and PF detection.

https://github.com/buzsakilab/buzcode/blob/dev/tutorials/bz_tutorial_rateMapping.m

@brendonw1
Copy link
Collaborator

brendonw1 commented Jul 5, 2018 via email

@DavidTingley
Copy link
Collaborator

or this for optitrack systems, they should both produce that same *.behavior.mat file format (with additional Z and orientation data for optitrack)

https://github.com/buzsakilab/buzcode/blob/a12ded5f4a6bd538bbdb926ad7b901d4c13722c8/preprocessing/positionTracking/optitrack/bz_processConvertOptitrack2Behav.m

@evilrobotxoxo
Copy link
Collaborator

So everything here gets posted to Slack, but it doesn't work in the opposite direction, I guess. Anyway, yes, I will have a couple of students/technicians in the next few weeks who will need buzcode tutorials. In fact, I would appreciate a buzcode tutorial for myself, in terms of the standardized structs and etc.

@brendonw1
Copy link
Collaborator

brendonw1 commented Jul 5, 2018 via email

@DavidTingley
Copy link
Collaborator

@evilrobotxoxo I wouldn't mind using the slack channel more often but it hasn't really been adopted by many lab members here. @dlevenstein we could make another push for using it?

@brendonw1
Copy link
Collaborator

brendonw1 commented Jul 7, 2018 via email

@evilrobotxoxo
Copy link
Collaborator

evilrobotxoxo commented Jul 7, 2018 via email

@brendonw1
Copy link
Collaborator

brendonw1 commented Jul 8, 2018 via email

@AntonioFR8
Copy link
Collaborator

I have started writing some documentation in the form of Contents scripts for each main folder. I will be uploading them this week.
If anybody have strong opinion against I will also reorganize a bit the folders. Like creating a SharpWaveRipple folder inside LFP analysis were to put together related staff that is disperse now (i.e. in detectors)

@evilrobotxoxo
Copy link
Collaborator

evilrobotxoxo commented Jul 23, 2018 via email

@dlevenstein
Copy link
Collaborator Author

There's a function 'compileBuzcode' in the top folder. I thought we'd put in the readme that the user should run this before doing anything....... apparently we did not! I'll add it.

@dlevenstein
Copy link
Collaborator Author

(also, to my knowledge these files have to be compiled on the users computer)

@dlevenstein
Copy link
Collaborator Author

I just made some updates to the readme, that indicate the need to compileBuzcode first. Feel free to make it more helpful as you see fit!

@evilrobotxoxo
Copy link
Collaborator

evilrobotxoxo commented Jul 23, 2018 via email

@DavidTingley
Copy link
Collaborator

As you have people go through it @brendonw1 @evilrobotxoxo let us know what other tutorials would be most useful to upload first.

@brendonw1
Copy link
Collaborator

brendonw1 commented Jul 30, 2018 via email

@dlevenstein
Copy link
Collaborator Author

Add Thomas to this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

7 participants