Skip to content

Updated documentation - #5

Open
alex-sandercock wants to merge 2 commits into
developmentfrom
docs-call-origins
Open

alex-sandercock wants to merge 2 commits into
developmentfrom
docs-call-origins

Conversation

@alex-sandercock

Copy link
Copy Markdown
Contributor

Docs only updates

Genotype-calling tutorial and call page

  • The table headed "The same model in call" claimed more than was tested, and it gave call's defaults as polyRAD's IterateHWE. A new section, "How call Relates to polyRAD and updog", replaces it.
  • The section says what call adapts 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 the norm prior), and what is its own.
  • A table gives the settings that come closest to each package, with the share of genotypes that matched on four simulated tables of 18,000 genotypes each (updog 2.1.7 and polyRAD 2.0.1 at their defaults).
Package and model Closest settings in call Same genotypes
polyRAD, IterateHWE --prior hwe --overdispersion 9 --contamination-rate 0.001 --background-rate 0 All of them
updog, norm --prior norm --allele-bias fit 99% or more in the diploid and the tetraploids, 95% in the hexaploid
updog, hw --prior hwe --allele-bias fit 99% or more in the diploid and the tetraploids, 96% in the hexaploid

Changelog

  • The 0.14.0 entry was 1,456 words, against 11 to 110 for every earlier version. It is now 294 words in 6 bullets and marks call and filter-paralogs as experimental, as the README does.

Development record

  • The full table of the package comparison.
  • A new section on tiled markers, holding the measurements that were in the changelog and a check on 12 lettuce samples against 0.13.0 and the published genotypes.

The docs build with mdBook 0.5.2 and all 257 tests pass.

…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.
@alex-sandercock alex-sandercock self-assigned this Nov 16, 2026
Copilot AI lite review requested due to automatic review settings November 16, 2026 02:20

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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 call relates to polyRAD and updog, including measured genotype agreement.
  • Updates model attribution and comparison wording in the call documentation.
  • 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.
Copilot AI lite review requested due to automatic review settings November 16, 2026 03:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are identified, so the documentation changes are ready for approval.

No open issues 🎉

Review effort: Lite

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants