Vignette overhaul and "Get started" vignette

Đang mở
  • Có gì không ổn?
#216 2 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
15/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, r
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
R
Star
43
Fork
14
Merge trung bình
4 giờ 44 phút
Pull request đã merge (30 ngày)
15

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của DARTH-git/dampack

Tất cả issue của DARTH-git/dampack

Issue tương tự

Thêm issue về R

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.