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

feat: output read orientation fractions to json #169

Merged
merged 8 commits into from
Oct 9, 2024

Conversation

balajtimate
Copy link
Collaborator

Description

  • Add json output of the fractions of read orientation (number of mapped reads, fraction of SF, SR and final orientation) per input sample
  • Clean up debug logging

Type of change

  • New feature (non-breaking change which adds functionality)

Checklist

Please carefully read these items and tick them off if the statements are true
or do not apply.

  • I have performed a self-review of my own code
  • My code follows the existing coding style, lints and generates no new
    warnings
  • I have added type annotations to all function/method signatures, and I
    have added type annotations for any local variables that are non-trivial,
    potentially ambiguous or might otherwise benefit from explicit typing.
  • I have commented my code in hard-to-understand areas
  • I have added ["Google-style docstrings"] to all new modules, classes,
    methods/functions or updated previously existing ones
  • I have added tests that prove my fix is effective or that my feature
    works
  • New and existing unit tests pass locally with my changes and I have not
    reduced the code coverage relative to the previous state
  • I have updated any sections of the app's documentation that are affected
    by the proposed changes

If for some reason you are unable to tick off all boxes, please leave a
comment explaining the issue you are facing so that we can work on it
together.

Copy link

codecov bot commented Oct 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (d3cbe0e) to head (6828a24).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff            @@
##               dev      #169   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        13           
  Lines         1142      1164   +22     
=========================================
+ Hits          1142      1164   +22     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@balajtimate balajtimate requested a review from uniqueg October 8, 2024 08:28
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

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

Some minor issues. In addition to the ones mentioned in line, I'm wondering if there aren't some docs that need to be updated? Example outputs maybe?

htsinfer/get_read_orientation.py Show resolved Hide resolved
htsinfer/get_read_orientation.py Outdated Show resolved Hide resolved
htsinfer/get_read_orientation.py Outdated Show resolved Hide resolved
@balajtimate
Copy link
Collaborator Author

No docs update needed right now. I'll rewrite the full documentation on RtD, there it will be included.

@balajtimate balajtimate enabled auto-merge (squash) October 8, 2024 16:18
@uniqueg
Copy link
Member

uniqueg commented Oct 9, 2024

No docs update needed right now. I'll rewrite the full documentation on RtD, there it will be included.

Oh, never mind. Had only a brief look and thought that you'd ended up including the stats in the main output after all. But seeing now that you're just writing it into a separate file, as discussed 👍

@balajtimate balajtimate merged commit a081c35 into dev Oct 9, 2024
19 checks passed
@balajtimate balajtimate deleted the add_orientation_json branch October 9, 2024 06:59
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.

2 participants