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:
Extension of the file produced through batch ".bintest.cns"
Output format produced by bintest, which is actually closer to a ".cnr" (regarding coordinates mostly)
=> 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 !
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 insidepipeline.rst
, condidering it is a separate step of CNVkit's pipeline (one call CNV withbatch
and if some CNV are missing or higher resolution is needed, one can usebintest
) => Butpipeline.rst
is already really dense, so maybe a better emplacement can be found ?Important: I think there is a confusion between:
batch
".bintest.cns"bintest
, which is actually closer to a ".cnr" (regarding coordinates mostly)=> 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