Repository navigation
Updated documentation - #5
Open
alex-sandercock wants to merge 2 commits into
Open
alex-sandercock wants to merge 2 commits into
alex-sandercock wants to merge 2 commits into
Conversation
…ngelog The tutorial's table headed "The same model in call" claimed more than was tested, and gave call's defaults as polyRAD's IterateHWE. The section now says what call adapts from polyRAD (the likelihood, the Hardy-Weinberg prior with its selfing rate, the iteration) and from updog (the allelic bias and the norm prior), what is its own, and which settings come closest to each package, with how close they came. Each package ran at its defaults on four simulated tables of 18,000 genotypes. With polyRAD's settings call gave polyRAD's genotype in every cell. Its defaults do not. Beside updog norm and hw, call with the bias fitted gave the same genotype for 99% or more in the diploid and the tetraploids and 95 to 96% in the hexaploid. The development record has the table. The 0.14.0 changelog entry was 1,456 words, against 11 to 110 for every earlier version. It is now 294, and says what the release adds. The tile measurements it held move to the development record, with a check on 12 lettuce samples against 0.13.0 and against published genotypes.
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain, and the documentation-only changes clarify genotype-calling guidance, release notes, attribution, and supporting validation measurements.
No open issues 🎉
What changed in this PR
This documentation-only pull request clarifies genotype-calling guidance, condenses the 0.14.0 changelog, and records tiled-marker and package-comparison validation results.
Changes:
- Explains how
callrelates to polyRAD and updog, including measured genotype agreement. - Updates model attribution and comparison wording in the
calldocumentation. - Marks experimental commands in the changelog and documents supporting development measurements.
| File | Description |
|---|---|
| docs/src/tutorials/genotype-calling.md | Explains how call relates to polyRAD and updog and summarizes comparable settings and genotype-agreement results. |
| docs/src/development/changelog.md | Condenses the 0.14.0 release notes and marks call and filter-paralogs as experimental. |
| docs/src/commands/call.md | Updates model attribution and comparison wording for the call command. |
| docs/DEVELOPMENT.md | Records tiled-marker validation results and detailed package-comparison measurements. |
Review effort: Lite
…anges The settings table in the genotype-calling tutorial gains one row: for a mix of sample kinds, or when the kind is not known, add --prior norm (with --allele-bias auto for polyploids). The command page has the measurements for that row. A note under the table, and a fourth point on the command page, say how read depth changes the settings: the prior counts most at low depth, and a bias takes depth to find. The figures come from 162 simulated tables (updog's simulator, 60 markers by 150 samples, three draws of each scenario) at ploidy 2, 4 and 6, in five kinds of population, with and without a bias, and for tetraploids at 10, 25, 60 and 200 reads. The development record has the design, both tables and what they show.
This branch has not been deployed
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.
Docs only updates
Genotype-calling tutorial and
callpagecall" claimed more than was tested, and it gavecall's defaults as polyRAD'sIterateHWE. A new section, "HowcallRelates to polyRAD and updog", replaces it.calladapts from polyRAD (the read-count likelihood, the Hardy-Weinberg prior with its selfing rate, the repeated estimate of allele frequencies), what it adapts from updog (the allelic bias and thenormprior), and what is its own.callIterateHWE--prior hwe --overdispersion 9 --contamination-rate 0.001 --background-rate 0norm--prior norm --allele-bias fithw--prior hwe --allele-bias fitChangelog
callandfilter-paralogsas experimental, as the README does.Development record
The docs build with mdBook 0.5.2 and all 257 tests pass.