Skip to content

Commit

Permalink
updated the changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmbaazam committed Apr 21, 2023
1 parent 5e41267 commit 3b18492
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# bpmodels 0.2.1

## Minor functionality change

* `chain_sim()` now throws a warning, instead of an error, when `tree` is set
to `FALSE` with `serial` also specified. We assume that providing a serial
interval means you want the tree of transmissions to be simulated,
so `chain_sim()` internally sets `tree = TRUE` and throws a warning explaining
what happened. This behaviour should not break any simulations with previous
versions with `bpmodels`, but if it does, please submit an issue.
To remove the warning, the user should explicitly set `tree = TRUE` when
they specify `serial`.

# bpmodels 0.2.0

## Documentation
Expand All @@ -13,17 +26,6 @@ has been added and can be accessed on the
* The README's "quick start" section has been updated with what was
previously the introduction vignette.

## Minor functionality change

* `chain_sim()` now throws a warning, instead of an error, when `tree` is set
to `FALSE` with `serial` also specified. Providing a serial interval implicitly
means you want the tree of transmissions to be simulated, so `chain_sim()`
internally sets `tree = TRUE` and throws a warning explaining what happened.
This behaviour should not break any simulations with previous versions
with `bpmodels`, but if it does, please submit an issue.
To remove the warning, the user should explicitly set `tree = TRUE` when
they specify `serial`.

# bpmodels 0.1.9999

* faster, vectorised chain simulations
Expand Down

0 comments on commit 3b18492

Please sign in to comment.