epiverse-trace / episoap

[Not published - under active development] A Store of Outbreak Analytics Pipelines Provided as Rmarkdown Report Templates
https://epiverse-trace.github.io/episoap/
Other
4 stars 2 forks source link

Plotting SI with negative values in {episoap} templates #107

Closed CarmenTamayo closed 1 month ago

CarmenTamayo commented 7 months ago

On the current transmissibility template, the SI section includes a function to plot the SI distribution, which currently is restricted to positive values only. While this is the most common case, there are instances where the SI can also take negative values, such as when there's pre-symptomatic transmission and the IP is longer than the SI (see visualisation). This is the case for the study that comes up by default when using epiparameter_db for COVID-19.

Right now this is specified with si_x <- seq(1L, to = si$prob_dist$qf(0.999), by = 1L)

Should I change this to allow negative values as well?

Bisaloo commented 7 months ago

Yes, I guess it should then plot from the 0.01 quantile to the 0.999 quantile. How does this sound?

adamkucharski commented 7 months ago

Is this in the context of estimating R? As serial interval is often used as an easier-to-measure proxy for generation interval (which is always positive), perhaps something to flag to users (so they don't inadvertently make an assumption that cases can infect people in the past!)

CarmenTamayo commented 7 months ago

On the issue I was referring to the section of the template where the SI is plotted, I was wondering if we should plot the entire distribution or keep it as it is to keep only the positive values. However the same object si_x with a vector of values from the distribution is then used in subsequent steps to by EpiNow2 and R0 for the generation time distribution

CarmenTamayo commented 6 months ago

To follow up on this issue, the SI distribution (which can have negative values with the normal distribution) is used in the main skeleton of the report for plotting and in the rmd chunks for estimating the generation time. I suggest that the plot includes all the values of the distribution, from min to max, and that the samples taken from the distribution to estimate GT in the code chunks are restricted to only contain positive values

Bisaloo commented 6 months ago

That sounds good to me. We just need to make sure this is very explicitly documented.

I may also suggest to wait until https://github.com/epiverse-trace/episoap/issues/109#issuecomment-1850168485 is solved before moving forward on this issue. We may decide to tackle this issue on epiparameter's side.

CarmenTamayo commented 4 months ago

@Bisaloo this issue and issue #109 are the only 2 ones left that are kind of blocking merging the PR

Bisaloo commented 4 months ago

I see this as a separate issue. Let's address it in a follow up PR.