Conversation
…t rarefaction depth
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
📝 Summary
Hardens the Kraken/Bracken report parser to gracefully skip blank and
#-commented lines, fixing a latent crash where such lines fell through to aValueErroron tuple unpacking. Additionally,calc_beta_divnow emits aUserWarningnaming every sample excluded for falling below the rarefaction depth instead of silently dropping them.🛠 Type of Change
🔍 Key Changes
transform2mpa._parse_line: strip the line and return[]immediately for blank or#-commented input, preventing downstream unpacking errors.transform2mpa.kreport_to_mpa: replace theis Nonecheck withnot report_valsso the empty-list return from_parse_lineis correctly treated as a skip.krakenparser.py: addimport warningsand overridewarnings.formatwarningto suppress source file/line noise, showing only the message text; broaden themain_callbackerror handler to also catchValueError.stats/diversity.calc_beta_div: track excluded samples with their total read counts and emit aUserWarning(plus a log warning) listing them when any are dropped belowrarefaction_depth; added aWarns:docstring section._parse_line, an integration test verifying noisy reports produce identical output to clean ones, and a test asserting the exclusion warning names the affected sample.🧪 How Has This Been Tested?
test_units.py) verify_parse_linereturns[]for blank ("\n"," \n") and commented ("# some comment\n") lines.test_integration.py) confirms a report with leading blank/comment lines yields byte-identical output to the clean report.calc_beta_divraisesUserWarningmatching the excluded sample id (S3) when a sample is below the rarefaction depth.