Optional incompleteness flag for required features (start_codon / stop_codon / CDS pairs)

Aperta
#66 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
data

Direzione di ricerca

Inizia dal punto di ingresso read_gtf e dal percorso esistente per le righe e l’espansione degli attributi descritto nell’issue. Decidi se il risultato opt-in debba aggiungere colonne di completezza o restituire un DataFrame complementare, quindi verifica che distingua i trascritti le cui righe CDS non contengono feature start_codon o stop_codon.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Background

GTF files don't enforce that a protein-coding transcript has both a start_codon and a stop_codon row — partial assemblies (e.g. TAIR chr_patch_hapl_scaff fragments, openvax/pyensembl#252) drop one or both even though CDS rows are present. Downstream consumers (pyensembl in particular) discover this at query time — Transcript.coding_sequence had to learn to return None rather than raise.

If gtfparse optionally surfaced this incompleteness at parse time, downstream tooling could decide its policy up front instead of catching KeyError / ValueError per-transcript.

Proposal

A transcript_completeness (or required_features_complete) DataFrame column, opt-in via a kwarg:

df = read_gtf(path, flag_incomplete_transcripts=True)
# adds a column 'has_start_codon' and 'has_stop_codon' aggregated over rows
# sharing transcript_id, or a single 'transcript_complete' boolean.

Or returned as a separate companion DataFrame indexed by transcript_id, so it doesn't bloat the main GTF DataFrame for callers that don't ask.

Scope guard

  • Arguably out of scope for a pure parser — "what's complete" is downstream policy. But the parse already scans every row to expand attributes; adding an aggregated boolean is cheap.
  • The exact set of "required" features is opinionated. The proposal here is the common case (CDS rows imply you need start_codon and stop_codon for that transcript to be translatable).

Related

  • openvax/pyensembl#252 — TAIR fragments
  • openvax/pyensembl#176 — coding_sequence_position_ranges initially didn't include stop codon
Lingua principale
Python
Stelle
130
Fork
34
Merge medio
23h 45m
PR unite (30g)
9

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openvax/gtfparse

Tutte le issue di openvax/gtfparse

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.