Expose additional parameters and document omissions (#168) - #331
Open
PriyankaaXD wants to merge 2 commits into
Open
PriyankaaXD wants to merge 2 commits into
PriyankaaXD wants to merge 2 commits into
Conversation
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Contributor
Author
|
Will follow up with a tools/CHANGELOG.md entry in a moment now that I have the PR number — wanted to get this open first since I needed the number to link it correctly. |
PriyankaaXD
force-pushed
the
expose-parameters-168
branch
from
September 16, 2026 12:24
f756ef2 to
e322d0b
Compare
Contributor
Author
|
Added the tools/CHANGELOG.md entry — this should be ready for review now. |
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.
Closes #168 (partially — STAR and Kraken2 specifically; other tools mentioned in the issue can be follow-ups).
Summary
Audited STAR and Kraken2 (the two tools called out in #168) for undocumented/unexposed parameters, and introduced the
omitted_parametersmetakey convention discussed in the issue for documenting intentional omissions in a structured, greppable way.Changes
tools/kraken2.wdl(krakentask)--confidence,--minimum-hit-groups, and--quickas new inputs (confidence,minimum_hit_groups,quick)--memory-mappingwas considered and intentionally not added, per discussion on the issue (unclear RAM/time tradeoff, and WDL execution environments are rarely memory-constrained)tools/star.wdl(alignmenttask)omitted_parametersdocumenting two previously-unexplained hardcoded flags:--outSAMtype: intentionally fixed toBAM Unsorted— STAR's own sort implementation is inefficient in the worst case; sorting is handled by a dedicated downstream task instead--outMultimapperOrder: intentionally fixed toRandom— the alternative (Old_2.4) is a biased quasi-random order predating STAR 2.5.0 and expected to be deprecatedtools/qualimap.wdl(rnaseqtask)-pparameter into the newomitted_parametersstructure, as a reference implementation of the conventionTesting
sprocket checkpasses on all three filessprocket dev test tools/star.wdl -t alignment: 4/4 passingsprocket dev test tools/kraken2.wdl -t kraken: 16/16 passingkraken2::krakenchanges are covered by its existingworkstest above.qualimap::rnaseqhas no existing test suite to extend, and this change is meta-only (no behavior change), so no new tests were needed there either.Open questions for reviewers
omitted_parametersshape (array of{flag, reason}objects) the right convention going forward, or would you prefer something else (e.g. keyed by flag name)? Happy to adjust and propagate to other tools with known ghost omissions (STAR/Kraken2 were just the two named in the issue).Before submitting this PR, please make sure:
scripts/ordocker/directories, please ensure any image versions have been incremented accordingly!