Skip to content

docs: a descriptive page for every example dataset - #170

Open
timtreis wants to merge 6 commits into
mainfrom
feat/dataset-docs
Open

timtreis wants to merge 6 commits into
mainfrom
feat/dataset-docs

Conversation

@timtreis

Copy link
Copy Markdown
Member

Inventories every mt.ds dataset and adds a descriptive page (context plus plots) for the ones that lacked one, woven into the docs {toctree}.

What changed

Ten new docs/datasets/*.ipynb pages, one per public example dataset that had none: chroma, cp_posh, jump_crispr, jump_export, jump_plate, neuropainting, pki, pooled_rare, rohban, scallops_arv471. Each page carries an import/setup cell, factual markdown context (assay, accession, shape, controls, what the dataset uniquely demonstrates), and one to three descriptive plots (real mt.pl functions, scanpy PCA rendered with plotly, or an image/table where those fit the type). Every new page is registered in the "Dataset pages" toctree in docs/api/datasets.md.

Verification

  • Every new notebook re-executed with a real kernel so outputs embed; 0 error outputs.
  • sphinx-build ... -W (nitpicky) exits 0 with no warnings.
  • ruff check and ruff format --check clean on the notebooks.
  • Diff is only the ten new docs/datasets/*.ipynb and the toctree edit; no src, loader or registry changes.

Notes

  • chroma: the rehosted well table keeps only the features shared across all eight acquisitions, which are the channel-agnostic shape descriptors and the Brightfield textures, so the extra dye channels that motivate the pilot are described in text and shown as a channel breakdown rather than plotted from per-dye features.
  • neuropainting: the genotype and donor design factor is dropped by the per-plate column intersect, so the page groups by plate and notes the missing columns.

This was originally stacked on #169; that PR has since merged, so it now targets main directly.

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@codecov-commenter

codecov-commenter commented Sep 29, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.21%. Comparing base (419c73d) to head (53909fa).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #170      +/-   ##
==========================================
+ Coverage   87.20%   87.21%   +0.01%     
==========================================
  Files          87       87              
  Lines        7557     7574      +17     
==========================================
+ Hits         6590     6606      +16     
- Misses        967      968       +1     
Files with missing lines Coverage Δ
src/mantispy/pl/_cluster.py 100.00% <100.00%> (ø)
src/mantispy/pl/_common.py 96.66% <100.00%> (+0.17%) ⬆️
src/mantispy/pl/_diagnostics.py 95.65% <100.00%> (-2.11%) ⬇️
src/mantispy/pl/_evaluation.py 98.94% <100.00%> (+0.01%) ⬆️
src/mantispy/pl/_features.py 98.21% <100.00%> (+0.03%) ⬆️
src/mantispy/pl/_heterogeneity.py 96.84% <100.00%> (+0.03%) ⬆️
src/mantispy/pl/_hits.py 99.37% <100.00%> (+<0.01%) ⬆️
src/mantispy/pl/_moa.py 99.09% <100.00%> (+<0.01%) ⬆️
src/mantispy/pl/_plate.py 96.96% <100.00%> (+1.65%) ⬆️
src/mantispy/pl/_qc.py 97.70% <100.00%> (+0.01%) ⬆️
... and 2 more
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@timtreis
timtreis marked this pull request as ready for review September 29, 2026 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants