search

Clinical-Genomics-Umea / fraggler

MIT License
0 stars 2 forks source link

JOSS review - API documentation #16

Closed KatyBrown closed 1 month ago

KatyBrown commented 2 months ago

Issue raised as part of the JOSS review process to address the "Functionality Documentation" check https://github.com/openjournals/joss-reviews/issues/6869

The link to the API documentation in the README.md leads to a page which I think has missing information - https://clinical-genomics-umea.github.io/fraggler/fraggler.html - here I just see the below: image

The "fraggler" submodule link leads to the detailed code documentation describing the functions - but there is no overview of how to use the API version of the tool.

willros commented 1 month ago

Hi @KatyBrown!

The API of Fraggler is best demonstrated in the tutorial.ipynb. This notebook documents everything needed to use Fraggler in a Python environment.

The link to the documentation provides a comprehensive overview of the source code. I have tried to document and describe the code thoroughly, making it easy to understand the logic and flow.

Hope this helps!

William

KatyBrown commented 1 month ago

I see, I was expecting that the link above was the main documentation of the API.