Skip to content

docs: remove methods/statistical_models page; rescue WASP2 contracts to user_guide/analysis#107

Merged
Jaureguy760 merged 1 commit intodevfrom
feat/docs-delete-statistical-models
Apr 19, 2026
Merged

docs: remove methods/statistical_models page; rescue WASP2 contracts to user_guide/analysis#107
Jaureguy760 merged 1 commit intodevfrom
feat/docs-delete-statistical-models

Conversation

@Jaureguy760
Copy link
Copy Markdown
Collaborator

Summary

Removes `methods/statistical_models.rst` (178 lines). The four WASP2-unique contracts flagged in the earlier sophia decision-auditor + co-scientist hypothesis-critic review are preserved as a compact "Defaults and contracts" section (~25 lines) in `user_guide/analysis.rst`.

Methods section is now a single page: `mapping_filter.rst`.

What's preserved in user_guide/analysis.rst

  1. `pseudocount=1` and `min_count=10` defaults
  2. Profile-LRT ρ convention (ρ held at null-MLE, df=1) — the PR docs: reduce text volume (~47%) + fix scientific correctness issues #99 scientific-correctness fix
  3. ρ bounds `(1e-6, 1-1e-6)` and linear-dispersion logit clip `±10`
  4. BH-NaN trap warning

Plus a pointer to `methods/mapping_filter.rst` for the canonical filter contract that applies to both remap and count steps.

Cross-refs updated (6)

  • `index.rst` toctree entry removed
  • `faq.rst` → `user_guide/analysis`
  • `tutorials/bulk_workflow.rst` (2 occurrences) → `user_guide/analysis`
  • `tutorials/single_cell_workflow.rst` → `methods/mapping_filter`
  • `methods/mapping_filter.rst` → `user_guide/analysis`

Verification

  • Sphinx build clean; `grep` confirms zero orphan `:doc:` refs
  • CI: ruff + Rust + pytest 3.10/3.11/3.12 + CodeQL

Result

  • Methods section: 2 pages → 1 (−178 lines)
  • docs/source total: ~2,490 → ~2,310 lines (~−63% cumulative since session start)

…_guide/analysis

Per user direction, the consolidated statistical_models.rst is removed.
Methods section is now a single page: mapping_filter.rst (canonical WASP
filter contract, van de Geijn 2015).

Rescued into user_guide/analysis.rst under a new "Defaults and contracts"
section (~25 lines) to avoid losing the four WASP2-unique contracts that
both the sophia decision-auditor and co-scientist hypothesis-critic
flagged as load-bearing when the original "delete the stats stuff"
proposal was evaluated:

1. pseudocount=1 + min_count=10 defaults
2. Profile-LRT ρ convention (ρ at null-MLE, df=1) — the scientific fix
   from PR #99
3. ρ bounds (1e-6, 1-1e-6) and linear-dispersion logit clip (±10)
4. BH-NaN trap warning (scipy raises; manual loop silently propagates)

Plus pointer to mapping_filter.rst for the canonical filter contract
that applies to both remapping and counting.

Updated 6 inbound :doc: references:
- index.rst toctree (removed entry)
- faq.rst → points to user_guide/analysis
- tutorials/bulk_workflow.rst (2 refs) → user_guide/analysis
- tutorials/single_cell_workflow.rst → methods/mapping_filter
- methods/mapping_filter.rst → user_guide/analysis

Sphinx build clean, zero warnings.
@Jaureguy760 Jaureguy760 merged commit c5d24e7 into dev Apr 19, 2026
6 checks passed
@Jaureguy760 Jaureguy760 deleted the feat/docs-delete-statistical-models branch April 19, 2026 09:55
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.

1 participant