about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorPjotr <wrk@bosa.lan>2026-11-10 18:49:09 +0000
committerPjotr <wrk@bosa.lan>2026-11-10 18:49:09 +0000
commitfc99de3a5e8dfe2f54ac7e34e7422672baaa97bc (patch)
tree48d75b7ece7f67bbc22b623aa7e02ed6128411af /docs
parentd614b073351773fa5b698a3c8a4374191e9341b9 (diff)
downloadgenenetwork4-fc99de3a5e8dfe2f54ac7e34e7422672baaa97bc.tar.gz
api: scans point at the class counts behind their own peak
The gotcha notes in SKILL.md tell an agent to count the animals per
genotype class before believing a peak; a note in a document is only
found by whoever reads it, so the replies now say it too, at the peak
they just computed.

  * suggest::class_hint builds
    /groups/{g}/genotypes/{v}/markers/{peak}/classes?trait={trait_id} --
    a real GET with one placeholder, because a scan knows the trait's
    values, not its PublishXRef.Id.
  * /compute/{rqtl,gemma,qtl2,fitqtl} add it to `next` after the PheWAS
    link, naming the peak each reply found and the version the request
    named (a {version} placeholder when it named none).
  * The genotype subtree carries the template too: a version's detail,
    and a concrete marker's own links.
  * /compute/qtl2 gains the sentence that explains the divergence: on a
    riself (riset) panel heterozygous calls are dropped before the scan
    (R/qtl's convert2riself) and the HMM re-imputes them, while GEMMA
    keeps them at dosage 0.5, so a mostly-H marker cannot peak there and
    two engines can name different markers of one region without either
    being wrong.

tests/links.rs: a scan's reply offers the class counts at its own peak --
the link names the version and the peak marker the reply reports, and
leaves {trait_id} for the caller.
Diffstat (limited to 'docs')
-rw-r--r--docs/www/SKILL.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/www/SKILL.md b/docs/www/SKILL.md
index 2688f24..0f0638c 100644
--- a/docs/www/SKILL.md
+++ b/docs/www/SKILL.md
@@ -197,6 +197,10 @@ header (peak and, for GEMMA, the Bonferroni line).
   flat LOD as real data. Probability-valued files are binned 0.05 wide
   (`?bin=` to change); a file over 256 MB is refused (413) rather than
   read.
+* Compute replies carry the class-count hint at their own peak
+  (`.../markers/{peak}/classes?trait={trait_id}`): filling in the trait id is
+  how you check a peak before reporting it, and `/compute/qtl2`'s `notes`
+  explains what a `riself` conversion did to `H`.
 * Follow `next` freely: every link is a `GET` that returns 200, and the API
   offers the whole graph from any response (genotypes -> frequencies ->
   markers -> a marker's location/tally -> PheWAS; trait -> values ->