openvax / varcode / 25751855180
88%

DEFAULT BRANCH: main
Ran
Jobs 0
Files 0
Run time –
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
25751855180

push

github

web-flow 
Attach optional genome FASTA + tiered reference lookup (#372, planning + scaffold) (#373)

* Scaffold varcode/genome_sequence with attach_genome_fasta signatures (#372)

Planning PR — implementation tracked in the description. This commit
adds only the minimal structural pieces:

* varcode/genome_sequence.py with attach_genome_fasta + reference_base
  + reference_range signatures, full module docstring spelling out
  the tiered-lookup contract (FASTA -> transcript cDNA -> empty).
  Bodies raise NotImplementedError pointing at #372.
* Top-level exports in varcode/__init__.py.

The conceptual framing: the pyensembl Genome IS varcode's reference,
just incomplete (transcript-only by default). attach_genome_fasta
extends it with full chromosome-level access. No new "Reference"
abstraction; consumers read via reference_base / reference_range
helpers that handle the tier fallback internally.

* Implement attach_genome_fasta + tiered reference lookup (#372)

Body for the scaffold from the previous commit. Implements all three
tiers, the duck-typed FASTA acceptance with probe validation, the
optional verify-on-attach spot check, and the Tier 2 range fast path.

Resolves review concerns:

* Mutates-shared-genome behavior documented loudly in attach_genome_fasta
  docstring; returns the genome for use as a pseudo-constructor.
* _resolve_fasta probes the candidate (arg[contig][0:1]) instead of
  trusting __getitem__ alone; rejects ints/lists with a useful TypeError.
* reference_range Tier 2 attempts a single-transcript range slice
  before falling back to per-position scanning (O(1) vs O(N) transcript
  lookups for the common case).
* verify=True (default) spot-checks the FASTA at up to 3 exonic
  positions and warns on disagreement (catches mislabeled FASTAs).
* attach_genome_fasta(g, None) detaches; clean for round-trip testing.
* Soft-masked (lowercase) bases are uppercased and lose the mask —
  documented in the module docstring.
* Multi-transcript Tier 2 bas... (continued)
Source Files on build 25751855180
Detailed source file information is not available for this build.