From f618e771c3d19dad9735390876212379f5cdb47f Mon Sep 17 00:00:00 2001 From: Sebastian Funk Date: Sun, 22 Oct 2023 08:52:14 +0100 Subject: [PATCH] improve README --- README.Rmd | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.Rmd b/README.Rmd index dc60382f0..947ca4362 100644 --- a/README.Rmd +++ b/README.Rmd @@ -104,19 +104,21 @@ reporting_delay <- estimate_delay( ) ``` -If data was not available we could instead make an informed estimate of the likely delay (*this is a synthetic example and not applicable to real world use cases and we have not included uncertainty to decrease runtimes*), +If data was not available we could instead make an informed estimate of the likely delay. We choose a lognormal distribution with mean 2, standard deviation 1 (both with some uncertainty) and maximum 10. *This is just an example and unlikely to apply in any particular use case*. ```{r} reporting_delay <- dist_spec( mean = convert_to_logmean(2, 1), + mean_sd = 1, sd = convert_to_logsd(2, 1), + sd_sd = 1, max = 10, dist = "lognormal" ) reporting_delay ``` -We use example literature estimates for the incubation period and generation time of Covid-19 (see [here](https://github.com/epiforecasts/EpiNow2/tree/main/data-raw) for the code that generates these estimates). *These distributions are unlikely to be applicable for your use case and do not have uncertainty associated with them. We strongly recommend investigating what might be the best distributions to use in any given use case.* +We use example literature estimates for the incubation period and generation time of Covid-19 (see [here](https://github.com/epiforecasts/EpiNow2/tree/main/data-raw) for the code that generates these estimates). *These distributions are unlikely to be applicable for your use case. We strongly recommend investigating what might be the best distributions to use in any given use case.* ```{r} example_generation_time