Reference documentation: examples for every exported function and Rd fixes

Aperta
  • Qualcosa non va?
#212 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à
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
r
Ambito
documentation

Direzione di ricerca

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.

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

Descrizione

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.
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.