openvax / varcode / 25893353585
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
25893353585

push

github

web-flow 
Rename Outcome -> EffectCandidate; document its purpose; drop description (#381)

Three cleanups on the multi-outcome wrapper:

1. Rename ``Outcome`` -> ``EffectCandidate``. The class wraps an
   Effect with provenance — "candidate effect with metadata" reads
   honestly. Module ``varcode.outcomes`` -> ``varcode.effect_candidates``;
   helper ``outcomes_from_candidates`` -> ``candidates_from_effects``;
   test file renamed in lockstep.

2. Drop ``EffectCandidate.description``. Pure passthrough to
   ``effect.short_description``; producers wanting a richer
   narrative attach it to the underlying Effect, not the wrapper.
   ``make_rna_outcome(description=...)`` kwarg also removed.

3. Module docstring now explains *why* the wrapper exists rather
   than just describing it: the same MutationEffect instance can
   appear in multiple multi-outcome contexts with different metadata
   per context (e.g. a splice candidate re-surfaced by the SV
   annotator with a different source tag). Without the wrapper, the
   alternatives are copy-everywhere, metadata-on-Effect (wrong: forces
   one labeling across contexts), or sidecar id() dicts.

Also: scrub aspirational "isovar" / "exacto" / "longread_assembly"
example tags from varcode docstrings — those integrations don't
exist yet; naming them as canonical examples implied a dependency
that hadn't shipped.

Hard rename, no deprecation alias. The class was only exported as
varcode.Outcome — update imports to varcode.EffectCandidate. The
MultiOutcomeEffect.candidates / .outcomes dual access stays
(distinct, complementary; raw vs wrapped); the "back-compat" framing
on .candidates is dropped.

1188 tests pass.
Source Files on build 25893353585
Detailed source file information is not available for this build.