Reference documentation: examples for every exported function and Rd fixes

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

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

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

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
48/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
活発
技術スタック
r
領域
documentation

調査の方向性

Start with the smaller Rd fixes: the wrong title in R/dsa_twoway.R:1, the missing backslash and the bad make_psa_object link in R/icers.R:187 and :190, and the make_psa() message in R/psa.R:86. Then look at the @keywords internal tags on plot.ceac and summary.ceac in R/ceac.R, and add @examples to the listed functions, using \donttest{} for slow ones. Done when devtools::check() shows no keyword NOTE and devtools::run_examples() passes.

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

説明

documentation

Suggested owner: Eva Enns (with a reviewer per area) · Plan: Phase 4

Goal

JOSS reviewers check that every exported function is documented with a runnable example. About 18 exported functions have no @examples. Several Rd pages have wrong titles or broken links.

Scope

  • Add @examples, using cancer_psa_data, hund_strat and psa_cdiff, to:

    • beta_params, calc_evppi, calc_evsi, calculate_icers_psa
    • create_dsa_oneway, create_dsa_twoway, metamodel, number_ticks
    • owsa, owsa_tornado, owsa_opt_strat, twsa
    • run_psa, run_owsa_det, run_twsa_det
    • the S3 plot, print and summary methods

    Use \donttest{} for anything slower than about 5 seconds.

  • Fix the Rd errors:

    • R/dsa_twoway.R:1 is titled "Create one-way deterministic sensitivity analysis object". It should say two-way.
    • R/icers.R:187 and R/icers.R:190 use \code{link{...}} without the backslash. Line 190 also points to the non-existent make_psa_object; it should be make_psa_obj.
    • The R/psa.R:86 error message tells users to run make_psa(); it should be make_psa_obj().
    • \keyword{distribution;} / \keyword{information;} entries flagged by R CMD check (beta_params, calc_evpi, dirichlet_params, gamma_params, lnorm_params) should become separate @keywords or @concept entries.
    • plot.ceac and summary.ceac are exported but tagged @keywords internal (R/ceac.R), which hides them from the index.
    • The lnorm_params example has a stale comment (R/gen_psa_samp.R, around line 456).

  • Dataset docs: add \format and \source to psa_cdiff and hund_strat. cancer_psa_data and df_example_psa_elc already have them.

Acceptance

  • devtools::check() shows no keyword NOTE.
  • Every exported function's Rd has an Examples section, and devtools::run_examples() passes.
主要言語
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 を短くまとめたダイジェスト。