Create documentation/vignette for the naming scheme of our functions

Aperta
  • Qualcosa non va?
#520 1 commento 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
r
Ambito
documentation

Direzione di ricerca

Inizia confrontando le convenzioni di denominazione descritte in questa issue con le funzioni e le classi attuali del package, in particolare scoring rules, get_ functions, plotting functions, add_ functions e input checks. Conferma con i maintainer quali indicazioni sono ancora attuali, quindi crea la vignette prevista che documenti lo schema concordato e i relativi esempi.

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

Descrizione

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
Lingua principale
R
Stelle
65
Fork
24
Merge medio
1h 24m
PR unite (30g)
2

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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

Tutte le issue di epiforecasts/scoringutils

Issue simili

Altre issue su R

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.