openvax / openvax/varcode

Change meaning of ref and alt fields

Open
#142 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
87
Forks
28
Avg merge
3h 27m
Merged PRs (30d)
27

Description

Currently variant.ref and variant.alt don't contain any shared prefix or suffix. This confuses user since they expect whatever values passed in for these fields to be unchanged.

Breaking change: rename the current ref and alt fields to trimmed_ref and trimmed_alt and get rid of original_ref and original_alt.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the definitions and usages of variant.ref, variant.alt, original_ref, and original_alt, including any related tests. Update the public field names as requested, then verify that callers use the unchanged input values and that the renamed trimmed fields retain their existing meaning.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
bioinformatics
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.