etal / cnvkit

Copy number variant detection from targeted DNA sequencing
http://cnvkit.readthedocs.org
Other
540 stars 164 forks source link

Improve bintest doc #646

Closed tetedange13 closed 2 years ago

tetedange13 commented 3 years ago

Hi all,

Regarding #621 and the need to properly document bintest

=> I did my best taking info from docstrings and previous cnv_ztest.py paragraph => Moved it to a dedicated new section inside pipeline.rst, condidering it is a separate step of CNVkit's pipeline (one call CNV with batch and if some CNV are missing or higher resolution is needed, one can use bintest) => But pipeline.rst is already really dense, so maybe a better emplacement can be found ?

Important: I think there is a confusion between:

=> Maybe something needs a fix here ? Anyway documentation I wrote is correct but a bit contradictory if you pay attention

Of course, feel free to tell me if this correct enough to you, or if I need to refactor / change some parts !

Hope this helps. Have a nice day. Felix.


Closes #621