[Docs] Overview of SPIMquant Workflows and Output Types#135
Closed
[Docs] Overview of SPIMquant Workflows and Output Types#135
Conversation
Agent-Logs-Url: https://github.com/khanlab/SPIMquant/sessions/2874f0f7-89b7-4f36-b1a6-7c849a044309 Co-authored-by: akhanf <11492701+akhanf@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update documentation for SPIMquant workflows and output types
[Docs] Overview of SPIMquant Workflows and Output Types
Mar 30, 2026
Member
|
closing this since out of date with naming refactor |
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.
Adds the missing narrative documentation for SPIMquant's pipeline — previously most reference pages were stubs with
<!-- TODO -->placeholders.New:
docs/reference/workflow_overview.md"How SPIMquant Works" end-to-end narrative. Covers all 8 major stages (import → masking → registration → segmentation → region props → quantification → heatmaps → group stats) plus optional vessel/patch/MRI stages. Each stage includes:
Updated:
docs/reference/outputs.mdFull output file reference replacing the stub:
.nii.gz,.ozx,.parquet,.tsv,.html, etc.)Updated:
docs/reference/rules.mdFull Snakemake rules reference replacing the stub — all rules grouped by
.smkfile with inputs, outputs, tools, and resource notes.Updated:
docs/howto/segmentation.mdPractical segmentation guide replacing the stub — covers bias correction methods,
thresholdvsotsu+k3i2, object filtering config, and the 0/100 mask scaling convention.Navigation / cross-links
mkdocs.yml: adds Workflow Overview, Output Files, Workflow Rules, DAG Visualization to Reference nav; Segmentation Methods to How-To Guidesdocs/index.md: adds Quick Links to the new overview and output pagesdocs/workflow_visualization.md: adds tip admonition pointing to the new narrative overview📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.