ringbp
ringbp copied to clipboard
epiforecasts
Simulate infectious disease transmission with contact tracing
The current version of the package is for a very specific branching process model. The package could be generalised to work for any (reasonable) branching process - but this needs...
Many exported functions have no `@return` documentation. By eye, it seems like many of them shouldn't be exported (i.e., they are internal interface, not capability you want to provide users),...
At the moment model parameters sit side-by-side as function arguments with simulation control arguments (i.e. how many simulations, when to stop etc.). If functionality is added to the model in...
The model parameters are defined multiple times across the package. It would be good to have a single reference in the documentation and use `@inheritParams` elsewhere, and to pass variables...
instead of the seemingly hardcoded https://github.com/epiforecasts/ringbp/blob/972bf86544e716b52d0da9f60f4681372760e9ec/R/scenario_sim.R#L81
E.g. running the readme followed by `res` will not produce any output until `res` is called again. This can be fixed by returning `res[]` instead of `res` e.g. in https://github.com/epiforecasts/ringbp/blob/972bf86544e716b52d0da9f60f4681372760e9ec/R/scenario_sim.R#L77
This function only calls `purrr::partial` with `rweibull` and the given parameters - if this is to be generalised (#59) then it could probably go altogether
Some parameters/distributions are hardcoded, e.g. the incubation period in https://github.com/epiforecasts/ringbp/blob/f8f1809d00094c04a39afb18e73e29dc3ef3be25/R/outbreak_model.R#L56 and the Weibull distribution in https://github.com/epiforecasts/ringbp/blob/f8f1809d00094c04a39afb18e73e29dc3ef3be25/R/aux_functions.R#L11 It would be good to make these arguments for greater generalisability
It would be good to run `styler`/`lintr` for a consistent and better readable code style
Metadata
Owner
Metadata
Simulate infectious disease transmission with contact tracing