Update README.md - #125
Merged
Merged
Conversation
monica-cheng1
enabled auto-merge
August 14, 2026 15:45
|
|
||
| - **Input:** MiXCR clonotype output (single-cell or bulk BCR repertoires) OR any clonotyping block | ||
| - **Output:** SHM lineage trees with per-clone mutation and maturation metrics | ||
| * **Input:** a MiXCR clonotype dataset (`.clns`) from [MiXCR Clonotyping](https://github.com/platforma-open/mixcr-clonotyping), [MiXCR Amplicon Alignment](https://github.com/platforma-open/mixcr-amplicon-alignment), [MiXCR scFv Alignment](https://github.com/platforma-open/mixcr-scfv-clonotyping), or [Cellecta DriverMap AIR](https://github.com/platforma-open/cellecta-drivermap-air-mixcr-clonotyping) — bulk or single-cell BCR — assembled by a feature broader than CDR3, such as VDJRegion. A donor metadata column is also required, since trees are built within a donor. Several datasets can be combined under one donor column. |
There was a problem hiding this comment.
Combined datasets require matching features
The README says several datasets can be combined but omits that every dataset must use the same assembling feature; combining eligible datasets with different features causes the workflow to panic instead of producing trees.
Suggested change
| * **Input:** a MiXCR clonotype dataset (`.clns`) from [MiXCR Clonotyping](https://github.com/platforma-open/mixcr-clonotyping), [MiXCR Amplicon Alignment](https://github.com/platforma-open/mixcr-amplicon-alignment), [MiXCR scFv Alignment](https://github.com/platforma-open/mixcr-scfv-clonotyping), or [Cellecta DriverMap AIR](https://github.com/platforma-open/cellecta-drivermap-air-mixcr-clonotyping) — bulk or single-cell BCR — assembled by a feature broader than CDR3, such as VDJRegion. A donor metadata column is also required, since trees are built within a donor. Several datasets can be combined under one donor column. | |
| * **Input:** a MiXCR clonotype dataset (`.clns`) from [MiXCR Clonotyping](https://github.com/platforma-open/mixcr-clonotyping), [MiXCR Amplicon Alignment](https://github.com/platforma-open/mixcr-amplicon-alignment), [MiXCR scFv Alignment](https://github.com/platforma-open/mixcr-scfv-clonotyping), or [Cellecta DriverMap AIR](https://github.com/platforma-open/cellecta-drivermap-air-mixcr-clonotyping) — bulk or single-cell BCR — assembled by a feature broader than CDR3, such as VDJRegion. A donor metadata column is also required, since trees are built within a donor. Several datasets can be combined under one donor column when they use the same assembling feature. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 28
Comment:
**Combined datasets require matching features**
The README says several datasets can be combined but omits that every dataset must use the same assembling feature; combining eligible datasets with different features causes the workflow to panic instead of producing trees.
```suggestion
* **Input:** a MiXCR clonotype dataset (`.clns`) from [MiXCR Clonotyping](https://github.com/platforma-open/mixcr-clonotyping), [MiXCR Amplicon Alignment](https://github.com/platforma-open/mixcr-amplicon-alignment), [MiXCR scFv Alignment](https://github.com/platforma-open/mixcr-scfv-clonotyping), or [Cellecta DriverMap AIR](https://github.com/platforma-open/cellecta-drivermap-air-mixcr-clonotyping) — bulk or single-cell BCR — assembled by a feature broader than CDR3, such as VDJRegion. A donor metadata column is also required, since trees are built within a donor. Several datasets can be combined under one donor column when they use the same assembling feature.
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
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.
Greptile Summary
The PR substantially expands the README with input requirements, specifications, use cases, FAQs, and citation details for MiXCR SHM Trees.
Confidence Score: 4/5
The documentation-only PR appears safe to merge after addressing the omitted multi-dataset constraint and visible typo.
The implementation supports most newly documented capabilities, but combining datasets with different assembling features aborts the workflow despite the README presenting combination without that qualification.
Files Needing Attention: README.md
Important Files Changed
Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "Update README.md" | Re-trigger Greptile