|
| 1 | +--- |
| 2 | +title: "simulist v0.6.0" |
| 3 | +author: |
| 4 | + - name: "The Epiverse-TRACE development team" |
| 5 | +date: "2025-08-28" |
| 6 | +categories: [new-release] |
| 7 | +code-link: true |
| 8 | +--- |
| 9 | + |
| 10 | +<!-- markdownlint-disable-next-line --> |
| 11 | +We are very excited to announce the release of a new [simulist](https://epiverse-trace.github.io/simulist) version v0.6.0. |
| 12 | +Here is an automatically generated summary of the changes in this version. |
| 13 | + |
| 14 | +```{r} |
| 15 | +library(simulist) |
| 16 | +``` |
| 17 | + |
| 18 | +In this minor version release we have continued to make a range of improvements across the package. A new line list post-processing function, `censor_linelist()`, makes it easy to group dates into various intervals, `messy_linelist()` introduced in v0.5.0 is enhanced, and the package documentation is expanded to cover under-reporting in outbreak data and censoring dates. There are also a couple of minor bug fixes. |
| 19 | + |
| 20 | +The development status of the package is updated to _stable_ from _experimental_ to reflect the long term stability and low probability of major changes. |
| 21 | + |
| 22 | +## New features |
| 23 | + |
| 24 | +* A new `censor_linelist()` function is added to the package. This is a new post-processing function for line list data to censor `<Date>` to daily, weekly and other user-defined time periods. The `censor_linelist()` also has a weekend-effect option to replicate the low reporting over weekends. This new feature also adds the {grates} package as a dependency (#240). |
| 25 | + |
| 26 | +* `messy_linelist()` can now accept a vector with multiple `missing_value`s to allow different values to represent missing data (#241). |
| 27 | + |
| 28 | +* A demonstration of how to replicate under-reporting of line list and contact tracing data is added to the `wrangling-linelist.Rmd` vignette. The demo contains examples for multiple types of under-reporting data found in real-world outbreaks (#244). |
| 29 | + |
| 30 | +## Breaking changes |
| 31 | + |
| 32 | +* The `$was_case` column in contact tracing data simulated by `sim_contacts()` now contains `logical` boolean values instead of `"Y"` and `"N"` `character` strings (#243). |
| 33 | + |
| 34 | +* The minimum R version required by the package is incremented to v4.2.0 due to a recursive dependency on {fastymd} (#235). |
| 35 | + |
| 36 | +## Minor changes |
| 37 | + |
| 38 | +* Documentation on censoring dates is added to `wrangling-linelist.Rmd` (#240). |
| 39 | + |
| 40 | +* Documentation on interoperability between {simulist} and {incidence2} for double precision `<Date>`s and warning for not specifying `interval` in `incidence2::incidence()` is added to `vis-linelist.Rmd` (#232). |
| 41 | + |
| 42 | +* The lifecycle of the package has been updated from _experimental_ to _stable_ (#229). |
| 43 | + |
| 44 | +* `@return` function documentation for exported functions is improved (#235). |
| 45 | + |
| 46 | +## Bug fixes |
| 47 | + |
| 48 | +* `truncate_linelist()` sets `$outcome` to `NA` if they are more recent than truncation time. This matches the way `$date_outcome` was handled in `truncate_linelist()` in v0.5.0 (#228). |
| 49 | + |
| 50 | +* Alt-text in vignettes is fixed to render correctly on pkgdown website (#230). |
| 51 | + |
| 52 | +## Deprecated and defunct |
| 53 | + |
| 54 | +* None |
| 55 | + |
| 56 | +## Acknowledgements |
| 57 | + |
| 58 | +[@joshwlambert](https://github.com/joshwlambert) [@avallecam](https://github.com/avallecam) [@TimTaylor](https://github.com/TimTaylor) [@sbfnk](https://github.com/sbfnk) [@seabbs](https://github.com/seabbs) |
0 commit comments