protontypes / AwesomeCure

Analyze and cure awesome lists by collecting, processing and presenting data from listed Git projects.
MIT License
17 stars 3 forks source link

Kasia's changes and comments #18

Closed KKulma closed 2 years ago

KKulma commented 2 years ago

@Ly0n It's not meant to be a formal PR, just an intro to the discussion! At this point, I focused on the code structure and readability, if there are any changes to the analysis I'll make them in a separate PR.

As the diff is too big to show on GitHub desktop and thus commenting is not possible there, I left my suggestions and questions in code comments starting with KK. Let me know what you think and once the comments are resolved/clarified I'll delete them and PR will be ready for an official review

Ly0n commented 2 years ago

I have just read your comments. Thank you very much. It's good that someone else is dealing with the code. We are planning to release the report as a Jupyter Book .

In this way we can add interactive plots and maybe also the Dash feature of Plotly. This would allow the user to change the input data of plots live. I have never tried this but hopefully the next week we will have a small example running so that we can evaluate how the plots are integrated at the end.

On the data mining script. It is in the same repository and is called awesomecure.ipynb. It is not the most beautiful code but it works so far. I actually applied for some funding yesterday to refactor the whole projects to a propor PyPI release. When the study is recieced well it would be great to repeat the study next year with a little bit of capacity.