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

オープン
  • 何か問題がありますか？
#214 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
25/100
issue の種類
リファクタリング
明瞭さ
おおむね明確
活発さ
活発
技術スタック
r
領域
data-visualization

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.
主要言語
R
スター
43
フォーク
14
平均マージ
4時間 44分
マージ済み PR（30日）
15

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

DARTH-git/dampack のほかの issue

DARTH-git/dampack の issue をすべて見る

似ている issue

R の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。