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

Enable cropped image-based output for .tiff files with SCDataFrame #44

Merged
merged 66 commits into from
Jul 4, 2024

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Jul 2, 2024

Description

This PR updates SCDataFrame to enable cropped image-based output for .tiff files in order to better visualize single-cell information in context with quality control aspects already implemented within coSMicQC. Along the journey towards this work I found that we needed to extend pandas.DataFrame through SCDataFrame in order to effectively achieve the related outcomes. This in turn caused many more changes to the SCDataFrame class which may not look necessary but ultimately enable the use of the class within Jupyter contexts (while retaining existing functionality).

I've added an example notebook to help demonstrate the capabilities found within this PR. Within this example notebook I also implement the existing label_outliers function and show the plots to help ensure all existing functionality was not impacted by the new additions found here.

The changes here strive towards #33 by addressing #40 (we still will need to find segmentation data and add this to display).

Closes #40

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.

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@d33bs d33bs marked this pull request as ready for review July 2, 2024 17:27
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 major issues or bugs. I left a few comments for you to address, let me know if you have any questions. LGTM!

CITATION.cff Outdated Show resolved Hide resolved
docs/examples/cosmicqc_in_a_nutshell.ipynb Outdated Show resolved Hide resolved
docs/examples/cosmicqc_in_a_nutshell.py Outdated Show resolved Hide resolved
docs/examples/cosmicqc_in_a_nutshell.py Show resolved Hide resolved
src/cosmicqc/__init__.py Show resolved Hide resolved
src/cosmicqc/analyze.py Show resolved Hide resolved
src/cosmicqc/frame.py Outdated Show resolved Hide resolved
@d33bs
Copy link
Member Author

d33bs commented Jul 4, 2024

Thanks Jenna for your review! I've addressed all comments and will now merge this in.

@d33bs d33bs merged commit 1bfa792 into WayScience:main Jul 4, 2024
11 checks passed
@d33bs d33bs deleted the scdataframe-image-display branch July 4, 2024 13:59
@d33bs d33bs mentioned this pull request Jul 26, 2024
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 SCDataFrame to show images within Jupyter cell output
2 participants