feat(github): add a form for the Studies using pathotypr category - #20
Merged
Conversation
The category was renamed from Show and tell and had no form, so it collected whatever people felt like writing. This asks for the handful of things that make a report useful to whoever reads it later. The version field carries a real warning rather than a tidiness request. Before 1.0.1, classify scanned only the forward strand and missed markers on reverse-oriented contigs, and genomes with no hits were dropped from the summary instead of being reported as unclassified. An analysis run on draft assemblies with 1.0.0 has to be read with that in mind, and the only way anyone finds that out is if the version is written down. The reference genome is required and the marker panel is not. That is deliberate: a panel read against a different assembly produces confident, wrong calls and says nothing about it, so the reference is the single most consequential detail on the form. The last field asks what was awkward. A real analysis knows things about a tool that no feature request written from the outside does. Filename checked against the live category slug, which is how the original marker proposal form came to be invisible for months.
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.
The category was renamed from Show and tell and had no form, so it collects whatever people feel like writing.
What it asks
Two choices worth explaining
The version field carries a real warning, not a tidiness request. Before 1.0.1,
classifyscanned only the forward strand and missed markers on reverse-oriented contigs, and genomes with no hits were dropped from the summary rather than reported as unclassified. An analysis run on draft assemblies with 1.0.0 has to be read with that in mind, and the only way anyone ever finds that out is if the version was written down.The reference genome is required and the panel is not. A panel read against a different assembly produces confident, wrong calls and says nothing about it. Knowing which panel was used is interesting; knowing which assembly it was read against is what makes the numbers interpretable.
Verified
The filename was checked against the live category slugs from the API, not assumed:
That check exists because getting it wrong is exactly how the original marker proposal form sat invisible: it was named
marker_proposal.ymlagainst categories that never included one.