Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update NEWS.md for v0.3.0 release #108

Merged
merged 2 commits into from
Oct 10, 2024
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
31 changes: 31 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
# superspreading (development version)

The third minor release of the _superspreading_ package contains enhancements to several functions and a new vignette.

We are also pleased to welcome Dillon Adam (@dcadam) as a new package author for his contributions towards this version.

## New features

* The `proportion_transmission()` function has been expanded to incorporate a new method. The new method calculates the proportion of transmission from X% the most infectious individuals, corresponding to the [Lloyd-Smith et al. (2005)](https://doi.org/10.1038%2Fnature04153) calculation. The `proportion_transmission()` has a new `method` argument to toggle between the two calculations (@dcadam, #99).
* A new vignette explaining the methods in the `proportion_transmission()` function (#101).
* {bpmodels} is removed as a package dependency and a branching process simulation function, modified from `bpmodels::chain_sim()`, is added to the {superspreading} package (#103). @sbfnk is added as copyright holder and @jamesmbaazam as a contributor.
* `probability_contain()` is enhanced to enable to probability of containment within a certain amount of time since the outbreak started. This adds `outbreak_time` and `generation_time` arguments to `probability_contain()`. This addition is backwards compatible as by default the time is unlimited, `outbreak_time = Inf`, and no generation time is required.

## Breaking changes

* The `stochastic` argument in `probability_contain()` has been renamed `simulate` to be consistent with other functions (#103).

## Minor changes

* The proportions output of `proportion_*()` functions are now formatted to significant figures rather than rounding to prevent small values being rounded to zero (#102).
* Improve input checking, error messages and edge case handling for functions (#102).
* Vignettes now use `rmarkdown::html_vignette` instead of `bookdown::html_vignette2` and `as_is: true` has been removed due to changes to {pkgdown} in v2.1.0. {bookdown} has been removed as a suggested package and code folding is removed from vignettes.
* The `get_epidist_params()` internal function has been renamed `get_epiparameter_params()` since {epiparameter} renamed the `<epidist>` class to `<epiparameter>` (#100).

## Bug fixes

* None to {superspreading} functions.
* Update {epiparameter} use in vignette and tests (#106).

## Deprecated and defunct

* None

# superspreading 0.2.0

Second minor release of _superspreading_. This release enhances functions added in v0.1.0 and adds two new exported functions, and two new vignettes.
Expand Down
1 change: 1 addition & 0 deletions inst/WORDLIST
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Althaus
Barré
Boëlle
Boesmans
bookdown
bpmodels
bw
Camacho
Expand Down
Loading