Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add SCDataFrame class to enable file-based or DataFrame-based data handling (input and output) #32

Merged
merged 27 commits into from
Jun 25, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Jun 11, 2024

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 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?

  • 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.

  • I have read and followed the CONTRIBUTING.md guidelines.
  • I have searched for existing content to ensure this is not a duplicate.
  • I have performed a self-review of these additions (including spelling, grammar, and related).
  • These changes pass all pre-commit checks.
  • I have added comments to my code to help provide understanding
  • I have added a test which covers the code changes found within this PR
  • I have deleted all non-relevant text in this pull request template.

@d33bs d33bs requested a review from jenna-tomkinson June 11, 2024 14:52
@d33bs d33bs mentioned this pull request Jun 12, 2024
11 tasks
@d33bs d33bs changed the title Add SCDataFrame class to enable file-based or DataFrame-based data handling Add SCDataFrame class to enable file-based or DataFrame-based data handling (input and output) Jun 18, 2024
Copy link
Member

@gwaybio gwaybio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Let's see what feedback Jenna has when she returns 🌴

src/cosmicqc/analyze.py Show resolved Hide resolved
src/cosmicqc/analyze.py Show resolved Hide resolved
src/cosmicqc/analyze.py Show resolved Hide resolved
src/cosmicqc/scdataframe.py Outdated Show resolved Hide resolved
src/cosmicqc/scdataframe.py Outdated Show resolved Hide resolved
src/cosmicqc/scdataframe.py Outdated Show resolved Hide resolved
src/cosmicqc/scdataframe.py Outdated Show resolved Hide resolved
src/cosmicqc/scdataframe.py Outdated Show resolved Hide resolved
tests/conftest.py Outdated Show resolved Hide resolved
tests/test_scdataframe.py Show resolved Hide resolved
Copy link
Member

@jenna-tomkinson jenna-tomkinson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am approving this PR since I don't see any obvious bugs or issues in the code. I have added a lot of clarifying comments and questions so feel free to address those when possible. This is really cool work!

pyproject.toml Show resolved Hide resolved
src/cosmicqc/__init__.py Show resolved Hide resolved
src/cosmicqc/analyze.py Outdated Show resolved Hide resolved
src/cosmicqc/analyze.py Show resolved Hide resolved
src/cosmicqc/scdataframe.py Outdated Show resolved Hide resolved
src/cosmicqc/scdataframe.py Show resolved Hide resolved
src/cosmicqc/scdataframe.py Outdated Show resolved Hide resolved
src/cosmicqc/scdataframe.py Show resolved Hide resolved
src/cosmicqc/scdataframe.py Show resolved Hide resolved
tests/test_scdataframe.py Show resolved Hide resolved
d33bs and others added 2 commits June 25, 2024 12:21
Co-authored-by: Jenna Tomkinson <107513215+jenna-tomkinson@users.noreply.github.com>
@d33bs
Copy link
Member Author

d33bs commented Jun 25, 2024

Thanks @gwaybio and @jenna-tomkinson for your thorough reviews! I've addressed your comments and will now merge this in.

@d33bs d33bs merged commit 197bc8a into WayScience:main Jun 25, 2024
11 checks passed
@d33bs d33bs deleted the add-file-data-ingest branch June 25, 2024 18:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enable file-based input
3 participants