genotoul-bioinfo / Binette

A fast and accurate binning refinement tool to constructs high quality MAGs from the output of multiple binning tools.
https://binette.readthedocs.io
MIT License
16 stars 1 forks source link

Better tutorial/data #19

Open lskatz opened 2 months ago

lskatz commented 2 months ago

Hi, this is coming off of #18 and as a comment on the review for JOSS https://github.com/openjournals/joss-reviews/issues/6782.

JeanMainguy commented 2 months ago

Hi,

I agree that would be important to provide a clear tutorial on how to use Binette with real data. I'll look into the best ways to include this in the repository. I'll probably add a new section in the documentation.

However, for GitHub Actions, I think we should stick to basic examples that demonstrate the full process without the size of real data. The main goal of the GitHub CI pipeline is to run tests when code changes, ensuring everything works as expected. Since these tests might run often, it's best to keep them quick to minimize computing time. So, I think the current test dataset fulfills this purpose well.

lskatz commented 2 months ago

Understood! I will strike the suggestion for using real data in github actions, but I would appreciate a clear tutorial using real data.