docs: add IVAC serosurvey demo notebook - #169
Merged
Merged
Conversation
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.
Add an executed 15-minute notebook for a mixed IVAC audience comparing 18 synthetic serosurvey designs by financial cost, overall prevalence-estimation error and underserved-group error. The narrative connects to IVAC's serosurveillance/costing work, exposes the
Studyand preference API, and includes four figures, result tables, presenter notes and budget/priority controls that reuse existing results.The companion model preserves population weights under oversampling, exact participant totals and independent phase/design/replicate streams. Both phases evaluate all designs; refinement changes simulation replication while preserving the population assumptions. All population inputs, prices and preference weights are explicitly hypothetical; Monte Carlo precision is distinguished from survey and model uncertainty.
Include a small
notebookextra, an illustrated guide, saved notebook outputs and CI execution in a fresh kernel with a 60-second per-cell timeout. Regression tests cover population weighting, known clustered-estimator mean/variance, reproducibility, financial costing and budget/no-choice behavior.Validation:
just ci(605 tests, 97.68% coverage), strict documentation build, notebook format/lint, isolated execution using only the notebook extra, and repeated fresh-kernel execution in 6–8 seconds including rendering. The companion script evaluates 19,800 surveys and saves four figures in about two seconds. Saved outputs were exported to HTML as a presentation backup.