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

Abierto
  • ¿Algo no está bien?
#214 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
25/100
Tipo de issue
Refactorización
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
r
Área
data-visualization

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.
Lenguaje dominante
R
Estrellas
43
Forks
14
Merge medio
4 h 44 min
PR fusionados (30 d)
15

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de DARTH-git/dampack

Todos los issues de DARTH-git/dampack

Issues similares

Más issues de R

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.