flatironinstitute / ironclust

Spike sorting software being developed at Flatiron Institute, based on JRCLUST (Janelia Rocket Cluster)
Apache License 2.0
28 stars 7 forks source link

ironclust vs JRCLUST? #26

Closed kouichi-c-nakamura closed 5 years ago

kouichi-c-nakamura commented 5 years ago

What is the difference and relationship between ironclust and JRCLUST ? Neither the Readme nor Wiki explains this basic question.

The documentation for ironclust is very limited, but can I refer to the JRCLUST documentation instead? I managed to run through the steps in the tutorial, but now I'm wondering how other people managed to use this tool.

jamesjun commented 5 years ago

Thanks for your interest Kouichi and I apologize for your frustration. I initially developed JRClust and I am continuing the development of IronClust since I joined Flatiron Institute. JRClust is currently maintained by Alan Liddell from Vidrio Technologies.

IronClust and JRClust interfaces are similar but IronClust has a few added features such as drift clustering view in the manual interface. I will update the documentation ASAP. Yes, you may refer to the JRClust documentation for the manual clustering.

The largest difference is how IronClust handles drift and the clustering method. IronClust uses anatomical similarity to define a local neighborhood and applies clustering by using a fixed neighborhood size. JRClust uses temporally close events to define a local neighborhood and uses the original Rodriguez-Laio clustering (DPCLUS). IronClust uses a modified version of DPCLUS based on KNN that can deal better with heterogenous cluster sizes. I am actively working on a manuscript and will post a bioRxiv paper soon.

-James

On Jul 16, 2019, at 8:00 PM, Kouichi C. Nakamura notifications@github.com wrote:

What is the difference and relationship between ironclust and JRClust? Neither the Readme nor Wiki explains this basic question.

The documentation for ironclust is very limited, but can I refer to the JRCLUST documentation instead? I managed to run through the steps in the tutorial, but now I'm wondering how other people managed to use this tool.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

jamesjun commented 5 years ago

One useful trick is press ‘h’ to display help in the user interfaces.

-James

On Jul 16, 2019, at 9:22 PM, James Jun jamesjun@gmail.com wrote:

Thanks for your interest Kouichi and I apologize for your frustration. I initially developed JRClust and I am continuing the development of IronClust since I joined Flatiron Institute. JRClust is currently maintained by Alan Liddell from Vidrio Technologies.

IronClust and JRClust interfaces are similar but IronClust has a few added features such as drift clustering view in the manual interface. I will update the documentation ASAP. Yes, you may refer to the JRClust documentation for the manual clustering.

The largest difference is how IronClust handles drift and the clustering method. IronClust uses anatomical similarity to define a local neighborhood and applies clustering by using a fixed neighborhood size. JRClust uses temporally close events to define a local neighborhood and uses the original Rodriguez-Laio clustering (DPCLUS). IronClust uses a modified version of DPCLUS based on KNN that can deal better with heterogenous cluster sizes. I am actively working on a manuscript and will post a bioRxiv paper soon.

-James

On Jul 16, 2019, at 8:00 PM, Kouichi C. Nakamura notifications@github.com wrote:

What is the difference and relationship between ironclust and JRClust? Neither the Readme nor Wiki explains this basic question.

The documentation for ironclust is very limited, but can I refer to the JRCLUST documentation instead? I managed to run through the steps in the tutorial, but now I'm wondering how other people managed to use this tool.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.

kouichi-c-nakamura commented 5 years ago

Thank you for clarifying the matter.

They're both your creation and hence similar. But IronClust is newer and has some improvements. Meanwhile, for most of the things, we can refer to JRClust documentation.

This is what I got. Cheers!

kouichi-c-nakamura commented 5 years ago

I've just closed the issue, but I'd like to add one thing.

Before writing massive documentation, just upload the screenshots of the demo code in Wiki or for README. At least, they'll inspire people!

Kouichi