about summary refs log tree commit diff
path: root/docs/WIP
diff options
context:
space:
mode:
authorFrederick Muriuki Muriithi <fredmanglis@gmail.com>2026-11-12 18:25:15 +0000
committerFrederick Muriuki Muriithi <fredmanglis@gmail.com>2026-11-12 14:40:27 -0600
commitdb733bda1ed65e810fb615190988d2e06c907463 (patch)
treeaa0e5964acd3f47158d66fab51c197b7b757322d /docs/WIP
parent1359c6f39264a603d88bde022f169e0955abd051 (diff)
downloadgn-uploader-main.tar.gz
docs: update implementation notes HEAD main
- record early heading, value and position validation
- record marker uniqueness implementation
- record the sample ordering implementation

Co-authored-by: pi coding agent <pi@pi.dev>
Diffstat (limited to 'docs/WIP')
-rw-r--r--docs/WIP/geno-uploads-implementation-notes.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/WIP/geno-uploads-implementation-notes.md b/docs/WIP/geno-uploads-implementation-notes.md
index c1761dc..ab6761f 100644
--- a/docs/WIP/geno-uploads-implementation-notes.md
+++ b/docs/WIP/geno-uploads-implementation-notes.md
@@ -49,6 +49,15 @@ Comment lines are cleaned by stripping the configured comment character and
 surrounding whitespace, then joined with `\n`; comment order is preserved when
 merging chunks.
 
+### Early data validation (done)
+
+Stage 01 flags empty or missing-value headings (the untransposed header row,
+the transposed first column and transposed marker headings), empty or
+missing-value marker/Chr/cM/Mb values, empty sample values, and negative or
+non-numeric cM/Mb values. cM/Mb values must be finite, non-negative numbers
+(integers are accepted). Empty strings are excluded from `geno_symbols`.
+Genuine missing genotype values must use the configured `na_strings`.
+
 ### Configuration
 
 `compute_statistics(filepath, fileconfigs)` expects a config dict with:
@@ -182,6 +191,23 @@ dropping comments and `@` directives (already captured in `FileStats`), leaving
 the original untouched, and rejecting ragged or empty matrices.
 `qc.check_file` now handles only the normal orientation.
 
+### Sample ordering (done)
+
+`uploader.genotypes.ordering` provides `proposed_order` (retain the population's
+existing order, append missing samples alphabetically, otherwise sort
+alphabetically), `population_sample_order` (reads `StrainXRef.OrderId`) and
+`is_valid_order` (validates a submitted order as a permutation of the file's
+samples). The QC success handler redirects to a sample-order review page; on
+acceptance it launches the next-stage job (type `genotype-stage04`) carrying
+`sample_order` and the preceding stage state in its metadata. A minimal Stage 04
+placeholder worker is the current hand-off point.
+
+### Marker uniqueness (done)
+
+Stage 03 QC tracks `(chromosome, marker)` pairs and reports an error when a
+marker name occurs more than once within the same chromosome. The same marker
+name may appear on different chromosomes.
+
 ### Stage 03 value QC
 
 Stage 02 launches the QC job with `stage02`, `genotype_collector_job_id`,