Vignette overhaul and "Get started" vignette

Abierto
  • ¿Algo no está bien?
#216 2 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
Más de una semana
Aptitud para principiantes
15/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
markdown, r
Área
documentation

Línea de trabajo

This is a multi-part tracking issue, not a single task: it covers a new Get started vignette, errata in basic_cea, psa_analysis, psa_generation, dsa_generation and voi, and removing unused files. Start with the vignettes/ directory and the specific error list under Fix the audit's errors. Done means each listed correction is made and the vignettes build in under two minutes, which requires a reviewer other than the author.

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

Descripción

documentation

Suggested owner: Eva Enns (an author and a second reviewer per vignette) · Plan: Phase 4

Goal

Vignettes that teach the methods correctly and build quickly. Fix the errors the audit found.

Scope

  • New vignettes/dampack.Rmd ("Get started"): a 5-minute end-to-end example covering ICERs, the PSA object, CEAC/ELC and EVPI. It becomes the pkgdown "Get started" page.
  • Reading order: Get started → basic_cea → psa_analysis → voi → psa_generation → dsa_generation.
  • Every vignette:
    • Learning objectives.
    • Methods with formulas: dominance, extended dominance, ICER, NMB/NHB, CEAC versus ELC and the frontier, EVPI/EVPPI/EVSI with the metamodel approach.
    • Interpretation.
    • References from a shared vignettes/references.bib.
    • set.seed() and DARTH naming in the example code.
  • Fix the audit's errors:
    • basic_cea: says the class is "icer" (it is icers); says "cdiff_psa" (the data is psa_cdiff); has an icer_diff typo; never shows print.icers or calculate_icers_psa.
    • psa_analysis:
      • The NMB/NHB formula text says "added to" where it should say subtracted.
      • The tornado text describes a median split, but the code uses the range min/max.
    • psa_generation:
      • Points to the wrong vignette.
      • Relies on partial argument matching (n = 100, effect =).
      • Says "Effect" where it should say "QALY".
      • Ends without any analysis.
    • dsa_generation: l_twsa_det$owsa_NMB typo; add the tornado diagram (#185).
    • voi: wrong help links ?make_psa_object and ?calculate_outcomes; says "adjusted r-squared" but lm reports the unadjusted value; cite Strong et al. 2014 in the vignette text.
  • Remove the unreferenced vignettes/icer_cdiff.png (186 KB) and vignettes/cdiff_icers.csv.
  • Speed: cut the 10,000-sample metamodel runs, or move heavy material to pkgdown-only articles (vignettes/articles/, build-ignored).
  • Close #147: dsa_visualization no longer exists. File a v1.2 issue for a "bring your own DSA data" section.

Acceptance

  • All vignettes build from a clean install, without load_all, in under 2 minutes total.
  • Each vignette has been reviewed by someone other than its author.
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.