search

Molmed / checkQC

CheckQC inspects the content of an Illumina runfolder and determines if it passes a set of quality criteria
http://checkqc.readthedocs.io/
GNU General Public License v3.0
25 stars 16 forks source link

"Complete" API Docs #43

Closed johandahlberg closed 6 years ago

johandahlberg commented 6 years ago

This should make most of the public API docs complete. I think that this should be enough that we can look into starting to auto-generate docs for e.g. ReadTheDocs, and then update things as we go later on.

There are a few minor refactorings going on in this PR as well, but nothing which should change the functionality in any meaningful way.

codecov[bot] commented 6 years ago

Codecov Report

Merging #43 into master will decrease coverage by 1%. The diff coverage is 77%.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #43    +/-   ##
=====================================
- Coverage      90%   90%   -<1%     
=====================================
  Files          19    18     -1     
  Lines         682   670    -12     
=====================================
- Hits          613   598    -15     
- Misses         69    72     +3
Impacted Files Coverage Δ
checkQC/run_type_summarizer.py 100% <ø> (ø) :arrow_up:
checkQC/parsers/parser.py 82% <ø> (-10%) :arrow_down:
checkQC/parsers/stats_json_parser.py 96% <ø> (ø) :arrow_up:
checkQC/handlers/cluster_pf_handler.py 96% <ø> (ø) :arrow_up:
checkQC/handlers/q30_handler.py 96% <ø> (ø) :arrow_up:
checkQC/handlers/reads_per_sample_handler.py 97% <ø> (ø) :arrow_up:
...heckQC/handlers/undetermined_percentage_handler.py 96% <ø> (ø) :arrow_up:
checkQC/parsers/interop_parser.py 98% <ø> (ø) :arrow_up:
checkQC/exceptions.py 100% <100%> (ø) :arrow_up:
checkQC/app.py 88% <100%> (ø) :arrow_up:
... and 7 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 54d4e2d...486c659. Read the comment docs.