Conversation
…tion logging and docstrings
…nce in CLI source code
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
Replaces non-ASCII characters (Greek letters, arrows) in CLI help text, docstrings, and log messages with ASCII equivalents to prevent Windows CP1252 console crashes, and documents that Bracken reports parse through the identical Kraken2 code path. Also adds regression tests, hand-computed reference-value assertions, and JOSS paper updates.
🛠 Type of Change
🔍 Key Changes
β-diversity/α-diversitywithbeta-diversity/alpha-diversityin CLI options, docstrings, and log messages acrosskrakenparser.py,pipeline.py, andstats/diversity.py➔arrows with->in pipeline help textSUPPORT.mdand cross-referenced it inCONTRIBUTING.mdandREADME.mdCONTRIBUTING.md1.1.3to1.1.4inpyproject.tomltest_source_has_no_non_ascii_cli_textenforcing ASCII-only CLI-facing source textbracken_kreport_filefixture andtest_kreport_to_mpa_parses_bracken_reportconfirming Bracken reports parse without special-casingtest_split_mpa_species_taxa_count_defaultverifying default human filteringpaper.mdwith a comparison table, correctedpandas/NumPy/SciPycitations, and refined scope descriptions🧪 How Has This Been Tested?
pytest(e.g.,pytest tests/test_units.py,pytest -k relabund)test_cli.pyparametrizes--helpacross all CLI apps and scans package source for non-ASCII characterstest_integration.pyasserts exact relative abundance percentages and rarefied Bray-Curtis (0.5) / Jaccard (1/3) distances using deterministicfixtures
rootis excluded from MPA output