This PR addresses #2 by adding report generation capabilities for coSMicQC. To do this I had to modify the dataframe schema of added columns which incurred other changes throughout. Generally I thought this would be helpful to include as part of the SCDataFrame class to help keep things tidy. I tried to keep the visualization flexible to any possible set of thresholds based on the existing defaults (trying to plan ahead and be flexible).
This should be reviewed and merged after #34
Preview of the report in Jupyter notebook:
Preview of the report in HTML (for CLI or export):
Closes #2
Closes #22
What kind of change(s) are included?
[x] Feature (adds or updates new capabilities)
[ ] Bug fix (fixes an issue).
[ ] Enhancement (adds functionality).
[ ] Breaking change (these changes would cause existing functionality to not work as expected).
Checklist
Please ensure that all boxes are checked before indicating that this pull request is ready for review.
[x] I have read and followed the CONTRIBUTING.md guidelines.
[x] I have searched for existing content to ensure this is not a duplicate.
[x] I have performed a self-review of these additions (including spelling, grammar, and related).
[x] These changes pass all pre-commit checks.
[x] I have added comments to my code to help provide understanding
[x] I have added a test which covers the code changes found within this PR
[x] I have deleted all non-relevant text in this pull request template.
Description
This PR addresses #2 by adding report generation capabilities for
coSMicQC
. To do this I had to modify the dataframe schema of added columns which incurred other changes throughout. Generally I thought this would be helpful to include as part of theSCDataFrame
class to help keep things tidy. I tried to keep the visualization flexible to any possible set of thresholds based on the existing defaults (trying to plan ahead and be flexible).This should be reviewed and merged after #34
Preview of the report in Jupyter notebook:
Preview of the report in HTML (for CLI or export):
Closes #2 Closes #22
What kind of change(s) are included?
Checklist
Please ensure that all boxes are checked before indicating that this pull request is ready for review.