This PR introduces a class called SCDataFrame which loosely wraps (but does not extend) pd.DataFrame to assist with file-based input handling with existing functions in coSMicQC. This prepares us for CLI development in #14 by allowing filepaths of data to be used as inputs for any function which is currently compatible with pd.DataFrame.
Sidenotes: I reset the __init__.py version to be 0.0.0 as this is now dynamically versioned on release. I also needed to update some of the existing tests to show that the capabilities haven't changed.
Thanks for any feedback you may have! Please don't hesitate to let me know if you have any questions.
Closes #31
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 introduces a class called
SCDataFrame
which loosely wraps (but does not extend)pd.DataFrame
to assist with file-based input handling with existing functions incoSMicQC
. This prepares us for CLI development in #14 by allowing filepaths of data to be used as inputs for any function which is currently compatible withpd.DataFrame
.Sidenotes: I reset the
__init__.py
version to be0.0.0
as this is now dynamically versioned on release. I also needed to update some of the existing tests to show that the capabilities haven't changed.Thanks for any feedback you may have! Please don't hesitate to let me know if you have any questions.
Closes #31
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.