docs: note the reduction key sanitization fix in README - #4
Merged
Conversation
Documents the umap_harmony / pca_uncorrected / mrVI_umap export fix under the existing correctness-fixes list.
There was a problem hiding this comment.
Pull request overview
Updates the project README to document the previously merged reduction key sanitization fix (PR #3), explaining that reductions with non‑alphanumeric names are no longer silently lost and that unmatched reductions now emit a warning.
Changes:
- Add a new bullet under “Correctness fixes” describing the reduction-name sanitization behavior change.
- Document warning behavior for reductions that still cannot be matched.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+32
to
+37
| - Reductions whose names contain non-alphanumeric characters (`umap_harmony`, | ||
| `pca_uncorrected`, `mrVI_umap`, ...) are no longer dropped from `obsm`. | ||
| Seurat strips those characters when it derives a reduction key | ||
| (`umap_harmony` -> `umapharmony_`), which previously made such reductions | ||
| fail the assay-matching check and be skipped silently. A reduction that is | ||
| still not matched now raises a warning instead of disappearing. |
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.
Follow-up to #3, which merged before this README change was pushed.
Documents the reduction-export fix under the existing "Correctness fixes" list in the README: reductions whose names contain non-alphanumeric characters (
umap_harmony,pca_uncorrected,mrVI_umap, ...) are no longer silently dropped fromobsm, and an unmatched reduction now warns instead of disappearing.Docs only — no code change.