search

cancerit / telomerecat

Telomerecat: The telomere computational analysis tool
GNU General Public License v3.0
20 stars 5 forks source link

Usage Instructions Missing #19

Closed DarioS closed 3 years ago

DarioS commented 4 years ago

There isn't any document describing how to use the software, only how to install it.

radwaraed commented 4 years ago

hi DarioS, if you type (telomerecat bam2length --help) or (telomerecat --help), it will guide you on how to use it. Or you can check out this page https://telomerecat.readthedocs.io/en/latest/estimating_telomere.html I agree with you though. It would be helpful to have a usage example in the readme

keiranmraine commented 3 years ago

I've added a minimal guide to getting the command line help for the next release:

https://github.com/cancerit/telomerecat/commit/7cb53f48b81fc386696684403d1202cff22bf379#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5