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 report generation capabilities #39

Merged
merged 49 commits into from
Jun 29, 2024
Merged

Conversation

d33bs
Copy link
Member

@d33bs d33bs commented Jun 21, 2024

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 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:
image

Preview of the report in HTML (for CLI or export):
image

Closes #2
Closes #22

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 marked this pull request as ready for review June 27, 2024 17:31
@d33bs d33bs requested review from jenna-tomkinson and gwaybio June 27, 2024 17:31
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.

Cool to see this! Maybe beyond scope of this PR, but I think it would be nice to have an option to export to PDF as well (in addition to HTML option)

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

LGTM! I left some general comments but the code looks to be good! Super exciting! 🎉

pyproject.toml Outdated Show resolved Hide resolved
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
d33bs and others added 2 commits June 29, 2024 13:30
Co-Authored-By: Jenna Tomkinson <107513215+jenna-tomkinson@users.noreply.github.com>
@d33bs d33bs mentioned this pull request Jun 29, 2024
@d33bs
Copy link
Member Author

d33bs commented Jun 29, 2024

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

@d33bs d33bs merged commit f4c51d7 into WayScience:main Jun 29, 2024
11 checks passed
@d33bs d33bs deleted the add-reports branch June 29, 2024 19:56
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.

Design initial report output Add report generation capabilities
3 participants