write proper documentation

iqbal-lab-org / varifier

Variant call verification

MIT License

15 stars 3 forks source link

write proper documentation #2

Open martinghunt opened 4 years ago

mbhall88 commented 4 years ago

@martinghunt it would be helpful if you could document what the different sections in the output JSON file are? I have the JSON but don't really know what the differences between each section are.

For example, what is the difference between these three fields?

 "Recall": 0.8943507,
 "Recall_edit_dist": 0.89991875,
 "Recall_frac": 0.93283834,

martinghunt commented 4 years ago

Yep, the documentation is on the to do list!

I just made this to answer that question. https://github.com/iqbal-lab-org/varifier/wiki/Summary-stats-JSON-file

bricoletc commented 3 years ago

A minor point, but would be nice to link to that wiki page in the README.