Harmonize plot-method arguments and `ceac()` argument order (soft deprecation)

Aperta
  • Qualcosa non va?
#214 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
25/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
r
Ambito
data-visualization

Direzione di ricerca

Start with the ceac() and calc_evpi() argument handling, then the plot.icers, plot.evpi, plot.evppi, plot.owsa, plot.exp_loss and plot.twsa methods, and owsa_opt_strat, to see where col, size/lsize, effect_units and xlim/ylim differ. Done means both ceac() argument orders work with one soft deprecation warning, new tests cover both forms, and the CONTRIBUTING ADR is merged. The open naming decisions need maintainer agreement before any rename.

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

Descrizione

feature

Suggested owner: Matthew Kaufmann · Plan: Phase 3 (timeboxed)

Goal

Make the API consistent without breaking v1.0.x code. Use lifecycle::deprecate_soft() for old call forms, and record the 2.0 naming targets in an ADR.

Scope

  • ceac(wtp, psa) versus calc_evpi(psa, wtp): ceac() should accept (psa, wtp). If the first argument is a psa object, use it directly. The old order still works, with a soft deprecation warning.
  • Shared plot arguments, added without breaking anything: currency, effect_units, col = c("access", "full", "bw"), txtsize, n_x_ticks/n_y_ticks, xlim/ylim. Current gaps:
    • plot.icers has fixed col.
    • plot.evpi and plot.evppi have no col.
    • plot.owsa uses size while plot.exp_loss uses lsize.
    • effect_units defaults to "QALYs" in plot.icers and "QALY" elsewhere.
    • plot.owsa, plot.twsa and owsa_opt_strat have no xlim/ylim.
  • One-page API style ADR in CONTRIBUTING (verb prefix, psa as first argument, effect versus effectiveness, column case Strategy/strategy). Larger renames such as calc_ versus calculate_ get aliases only if the team agrees (meeting decision 3).
  • summary.ceac's cost_eff_strat → optimal_strategy rename (#173) is accepted as a documented minor break.

Acceptance

  • The old call forms still work and give one soft deprecation warning.
  • New tests cover both forms.
  • The ADR is merged.
Lingua principale
R
Stelle
43
Fork
14
Merge medio
4h 44m
PR unite (30g)
15

Preparare l'ambiente

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 DARTH-git/dampack

Tutte le issue di DARTH-git/dampack

Issue simili

Altre issue su R

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.