diff options
Diffstat (limited to 'docs/genotypes.md')
| -rw-r--r-- | docs/genotypes.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/docs/genotypes.md b/docs/genotypes.md index 4835865..55f7a6d 100644 --- a/docs/genotypes.md +++ b/docs/genotypes.md @@ -101,6 +101,21 @@ and were posted to the API. | BXD, `BXD.8.geno` | R/qtl scanone | 10001 | 235 | 34 | 7.5 s | 21 056 markers | | HET3-ITP, `HET3-ITP.12.geno` (Apr 2023) | R/qtl scanone | 10000 lifespan | 6 447 | 6 438 | 83.1 s | 893 markers, peak LOD 7.95 at `1_24042124` (chr 1, 24.04 Mb) | +## What the API tells a caller about a genotype file + +Three routes, all behind the bearer token like every other endpoint: + +| route | what it gives | +|---|---| +| `GET /groups/{group}/genotypes` | versions newest-first, each with its `file` name, title, `individuals`, `markers`, which engines can use it, and which is `current` | +| `GET /groups/{group}/genotypes/{version}` | that file's `file` name, its header `@`-labels, the panel's `individuals` in file order, the `strains` a mapping uses, counts, and per-chromosome marker counts | +| `GET /groups/{group}/genotypes/{version}/markers?page=&limit=&chr=` | the marker table: name, chromosome, cM, Mb — paged, positional rows | + +**The genotype calls are never served.** A caller sees the panel, the +markers and the header, which is what it needs to frame a mapping and to +check one; the matrix itself stays on the server, and the compute +endpoints take a group and a version rather than a path. + ## Reproducing the measurements The measurements above were taken before the API took over the |
