Reference documentation: examples for every exported function and Rd fixes

Đang mở
  • Có gì không ổn?
#212 0 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ó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
48/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ệ
r
Lĩnh vực
documentation

Hướng nghiên cứu

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.

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