Priesemann-Group / covid19_inference

Bayesian python toolbox for inference and forecast of the spread of the Coronavirus
GNU General Public License v3.0
73 stars 70 forks source link

delay_cases function parameters #35

Open truEngineer opened 4 years ago

truEngineer commented 4 years ago

Hello. It is difficult to understand the description of the delay_cases function parameters.

def delay_cases(
    new_I_t,
    pr_median_delay=10,
    pr_sigma_median_delay=0.2,
    pr_median_scale_delay=0.3,
    pr_sigma_scale_delay=None,
    ...
):

Perhaps refactoring is needed here:

pr_median_delay : float
  The prior of the median delay [The prior for the median of the median delay distribution?]
scale_delay  [pr_median_scale_delay?] : float
  The scale of the delay, that is how wide the distribution is [?].
pr_sigma_median_delay : float
  The prior for the sigma of the median delay distribution.
[pr_sigma_scale_delay?]

Is the formula for y_delayed in the documentation correct?