Create documentation/vignette for the naming scheme of our functions

Đang mở
  • Có gì không ổn?
#520 1 bình luận 1 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
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
r
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng cách so sánh các quy ước đặt tên được mô tả trong issue này với các hàm và lớp hiện tại của package, đặc biệt là scoring rules, get_ functions, plotting functions, add_ functions và input checks. Xác nhận với các maintainer hướng dẫn nào vẫn còn phù hợp, sau đó tạo vignette đã lên kế hoạch để ghi lại scheme đã thống nhất và các ví dụ của nó.

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

Mô tả

help wanted question

Edit: Warning - this might be partly outdated.

We should aim for as much consistency as possible in naming things.

This issue summarises our current thinking and should eventually become a Vignette

Scoring rules

See #476 #610.

We call "scoring rule" any function that computes a score / metric / quantity of interest based on forecasts and observed values. We call "score" the output of a scoring rule.

"Scoring rule" usually means the specific R function that computes a score. We use sentences such as "you can pass a list of scoring rules to score(), or "you can call a scoring rule directly". And "scores are computed by scoring rules". Sometimes, "scoring rule" can also denote the function in a more abstract, mathematical sense. For example we would say "the absolute error is a scoring rule" or the "CRPS" is a proper scoring rule. Sometimes we use "rules" as short for "scoring rules", for example when naming function arguments.

In other contexts in the literature, "score" is also used as short for "scoring rule", for example in a sentence like "the CRPS is a proper score". We will avoid this terminology.

Scoring rules are consistently named in the following way:
<name of the scoring rule> + _ + <forecast type>

If there is only one forecast type for which a scoring rule is applicable, _ + <forecast type> is sometimes omitted.

get_-functions

  • functions with the prefix get_ are designed to provide additional information based on the data
  • they are usually called on the raw forecasts

Classes

We have one class for every forecast type

  • forecast_binary
  • forecast_point
  • forecast_sample
  • forecast_quantile

We have a class for the output of score():

  • score

Plotting functions

We briefly considered having classes solely for plotting (with the class named after the function). But then we decided to instead have dedicated plotting functions.

Plotting functions are named plot_ + name of function. If the function name has a prefix like get_, then that is replaced with plot_.
Examples: plot_forecast_counts, plot_correlation, plot_pairwise_comparion.

add_-functions

Functions with an add_ prefix add columns with additional information to their inputs.
add_pairwise_comparison()
add_coverage()
add_interval_range()

Internal input checks

check_, assert_, test_

  • assert_: Returns NULL invisibly if the assertion was successful and throws an error otherwise.
  • check_: Returns TRUE if the check was successful and a string with an error message otherwise
  • test_: Returns TRUE if the check was successful and FALSE otherwise
Ngôn ngữ chính
R
Star
65
Fork
24
Merge trung bình
1 giờ 24 phút
Pull request đã merge (30 ngày)
2

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

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 epiforecasts/scoringutils

Tất cả issue của epiforecasts/scoringutils

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.