search

genome / bam-readcount

Count bases in BAM/CRAM files
MIT License
298 stars 95 forks source link

[JOSS REVIEW] Any functionality documentation? #84

Closed bebatut closed 2 years ago

bebatut commented 2 years ago

Related to https://github.com/openjournals/joss-reviews/issues/3722:

Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?

Is there any functionality documentation? If there is, where can we find it? I could not find anything at first sight

apldx commented 2 years ago

Though the code is divided into a front-end and library, we don't aim to expose the library code as an API. For the command-line program bam-readcount, the intro section of the README.md hopefully indicates what it does, and then the actual usage is documented under Usage. The output is complicated and so has its own section Output. Do you have thoughts on what more might be needed? Thanks!

bebatut commented 2 years ago

It should be enough