epiverse-trace / simulist

An R package for simulating line lists
https://epiverse-trace.github.io/simulist/
Other
5 stars 1 forks source link

Remove `add_ct` argument #104

Closed joshwlambert closed 5 months ago

joshwlambert commented 5 months ago

This PR addresses part of #41 by removing the add_ct argument. The argument is removed from sim_linelist() and sim_outbreak() and internal functions that these exported functions call.

These changes move towards simplifying the function signatures of the exported simulation functions, as much as possible, as well as having consistent data output from exported functions. In this case the dimensions of the line list <data.frame> from sim_linelist() and sim_outbreak(). A bullet point has been added to the design principles vignette (design-principles.Rmd) to make this point.

A new vignette has been added on data wrangling. This vignette will grow over time to include common data wrangling tasks required for line list and contact tracing data; providing tidyverse and base R examples.