docs(tutorials): remove comparative_imbalance tutorial (redundant with user_guide)#105
Merged
Jaureguy760 merged 1 commit intodevfrom Apr 19, 2026
Merged
Conversation
The compare-imbalance CLI is fully documented in user_guide/analysis.rst (command, flags, usage, output interpretation). The 188-line tutorial page was entirely redundant — same H0/H1 formulation as statistical_models.rst, same barcode format as user_guide/single_cell.rst, and a matplotlib volcano-plot snippet that is generic to any p-value × effect-size pair. Preserved in user_guide/analysis.rst: a one-sentence note listing the three compare-imbalance-specific output columns (combined_mu, mu1, mu2) so the output interpretation is not lost. Updated 5 inbound :doc: references: - index.rst toctree entry removed - user_guide/single_cell.rst See Also line removed - user_guide/analysis.rst Next Steps line removed - tutorials/bulk_workflow.rst See Also line removed - tutorials/single_cell_workflow.rst: inline pointer rewritten to point at user_guide/analysis.rst instead; See Also line removed Tutorial section: 3 pages → 2 pages (bulk_workflow + single_cell_workflow).
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
1 participant
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.
Summary
Removes the 188-line `tutorials/comparative_imbalance.rst`. The `wasp2-analyze compare-imbalance` CLI is already fully documented in `user_guide/analysis.rst` (command, flags, usage, output interpretation); the tutorial page was redundant.
Preserved in `user_guide/analysis.rst`: a one-sentence note listing the three compare-imbalance-specific output columns (`combined_mu`, `mu1`, `mu2`) so nothing is lost.
Changes
Result
Test plan