feat(T2T): add initial implementation plan for T2T support - #230
Open
johausmann wants to merge 1 commit into
Open
feat(T2T): add initial implementation plan for T2T support#230johausmann wants to merge 1 commit into
johausmann wants to merge 1 commit into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds an initial technical implementation plan for supporting the T2T (CHM13v2.0) assembly in OBLX’s resource-pull and index-build Snakemake workflows.
Changes:
- Adds a step-by-step plan covering required config/schema updates for a
T2Tgenome build. - Outlines proposed new/modified pull rules for T2T-specific reference, annotation, variants, and masking resources (including a liftover path where needed).
- Lists required documentation and validation steps to integrate and dry-run the new build option.
Comments suppressed due to low confidence (3)
plans/T2T_implementation_plan.md:66
- Relative links in this section are also resolved from
plans/, so they currently point to non-existent paths (e.g.plans/docs/...). Update link targets to be root-relative or prefixed with../.
### A. [`docs/oblx/docs/configuration.md`](docs/oblx/docs/configuration.md)
- **Parameter List**: Update `genome_build` to include `T2T`.
- **Example Section**: Add a new "Example T2T" configuration block showing the use of `genome_build: T2T`.
### B. [`docs/oblx/docs/pull_resources.md`](docs/oblx/docs/pull_resources.md)
plans/T2T_implementation_plan.md:75
- These links are also relative to
plans/and will be broken as written; additionally, the LaTeX arrows in the validation bullet won’t render on GitHub.
### C. [`docs/oblx/docs/resources/human_resources.tsv`](docs/oblx/docs/resources/human_resources.tsv)
- **Resource Table**: Add new entries for the T2T reference genome, annotations, and liftovered VCFs to ensure traceability.
## 7. Integration & Testing
- **Path Mapping**: Update `get_pull_resources_output` in [`workflow/Snakefile`](workflow/Snakefile) to conditionally map T2T paths vs standard GRChx paths.
plans/T2T_implementation_plan.md:39
- More instances of
\$\\rightarrow\$appear in this section; since GitHub Markdown doesn’t render LaTeX math by default, replace these with a plain/unicode arrow to avoid the raw LaTeX showing up in rendered docs.
| **New** | `download_t2t_problematic_regions` | Download GIAB BigBed $\rightarrow$ convert to BED via `bigBedToBed`. | Use `use rule download_ucsc_data as ... with:`. <br> URL: `https://hgdownload.soe.ucsc.edu/gbdb/hs1/problematic/GIAB/alldifficultregions.bb` |
| **Redefined** | `download_repeat_masker` | Branch logic to support T2T sources instead of HG38-only paths. | Base rule $\rightarrow$ inherited T2T rule. |
## 3. Liftover Pipeline (GRCh38 $\rightarrow$ T2T)
Since native T2T resources for some tools are unavailable, a new sequence of rules is required:
johausmann
force-pushed
the
draft_T2T_support
branch
from
July 26, 2026 17:17
ee122a0 to
4472849
Compare
franla23
approved these changes
Jul 27, 2026
franla23
left a comment
Member
There was a problem hiding this comment.
Thanks, lgtm! Just wondering if it is better to maintain to have two independent workflow/rules/pull_resources.smk for hg38 and t2t as most of the rules have to be re-written.
Collaborator
|
Current state of the discussion:
|
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.
No description provided.