Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions _freeze/posts/simulist_v0.6.0/index/execute-results/html.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

58 changes: 58 additions & 0 deletions posts/simulist_v0.6.0/index.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: "simulist v0.6.0"
author:
- name: "The Epiverse-TRACE development team"
date: "2025-08-28"
categories: [new-release]
code-link: true
---

<!-- markdownlint-disable-next-line -->
We are very excited to announce the release of a new [simulist](https://epiverse-trace.github.io/simulist) version v0.6.0.
Here is an automatically generated summary of the changes in this version.

```{r}
library(simulist)
```

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.

The development status of the package is updated to _stable_ from _experimental_ to reflect the long term stability and low probability of major changes.

## New features

* 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).

* `messy_linelist()` can now accept a vector with multiple `missing_value`s to allow different values to represent missing data (#241).

* 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).

## Breaking changes

* 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).

* The minimum R version required by the package is incremented to v4.2.0 due to a recursive dependency on {fastymd} (#235).

## Minor changes

* Documentation on censoring dates is added to `wrangling-linelist.Rmd` (#240).

* 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).

* The lifecycle of the package has been updated from _experimental_ to _stable_ (#229).

* `@return` function documentation for exported functions is improved (#235).

## Bug fixes

* `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).

* Alt-text in vignettes is fixed to render correctly on pkgdown website (#230).

## Deprecated and defunct

* None

## Acknowledgements

[&#x0040;joshwlambert](https://github.com/joshwlambert) [&#x0040;avallecam](https://github.com/avallecam) [&#x0040;TimTaylor](https://github.com/TimTaylor) [&#x0040;sbfnk](https://github.com/sbfnk) [&#x0040;seabbs](https://github.com/seabbs)