Skip to content

docs(roadmap): plan Marimo research workbooks #130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pacharanero wants to merge 1 commit into
base: live
Choose a base branch
from
Open

docs(roadmap): plan Marimo research workbooks #130

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions spec/roadmap.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Complete these items before broad formatting, import cleanup, packaging reductio
- [x] **R27 - Route daily UK90 LMS generation to the reference-data project. (GitHub #79)** Daily table generation, source provenance, and validation belong in `rcpch/growth-references`; this Python package should consume an approved generated table. Issue #79 was closed with this decision.
- [ ] **R28 - Add test-coverage reporting. (GitHub #128)** Decide whether CI should publish coverage, enforce a threshold, or both. Start with a report-only baseline and avoid a blocking threshold until maintainers agree that the metric is meaningful for this suite.
- [ ] **R29 - Review the `Measurement.plottable_data` response shape for a future major version. (GitHub #24)** Keep the current public shape until the Python API, downstream server, and chart clients have an agreed migration plan. If simplifying the response, characterize compatibility and remove the redundant nested field only in a coordinated major-version change.
- [ ] **R30 - Replace Jupyter notebooks with reproducible Marimo research workbooks.** Migrate the existing notebooks to Marimo and establish a small set of researcher-friendly baseline workbooks for exploring supported references, representative measurements and generated chart output in the digital growth charts platform. Keep notebook dependencies optional, make workbook execution reproducible from a clean environment, and add a headless CI check. Preserve clinical calculations, reference data and golden outputs during the notebook-format migration; review any example or expected-value changes separately.
- [ ] **R3 - Decide the future of the unusable `BoneAge` class.** `rcpchgrowth/bone_age.py:12-48` returns a dictionary from `__init__`, so construction raises `TypeError: __init__() should return None`. The class has no internal consumers and is not exported from the package root, although related fields are supported by `Measurement`. Either implement and test a coherent object API or remove the module after checking external compatibility.
- [x] **R4 - Define an explicit runtime package-data allowlist.** Packaging now includes only the 15 JSON resources traced to production loads, and the artifact checkers reject every unapproved package resource.
- [x] **R5 - Exclude the test package from release wheels.** Package discovery excludes `rcpchgrowth.tests` and its subpackages, and the wheel checker rejects packaged test modules.
Expand Down
Loading