Skip to content

Commit c7486f1

Browse files
committed
Update NEWS with addition of Prem et al 2021
1 parent b8afe51 commit c7486f1

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

NEWS.md

+25
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1+
# contactdata 1.0.0
2+
3+
## New features
4+
5+
The updated data from Prem et al. (2021) has been added (#4). This results in a
6+
large number of cascading changes, including some breaking changes, detailed
7+
below.
8+
9+
### Breaking changes
10+
11+
* The new default returns data from the updated dataset. This means that any
12+
re-run of code written with previous versions of contactdata will return a
13+
different result
14+
* Arguments in `contact_df_countries()` have been removed and replaced by `...`
15+
to increase flexibility. This is only an interface change and does not modify
16+
the behaviour since all arguments were already forwarded to `contact_matrix()`.
17+
18+
### Non-breaking changes
19+
20+
* `list_countries()` and `contact_matrix()` now have two additional arguments:
21+
- `geographic_setting`, which specifies if you'd like to get the contact data
22+
from a `"rural"`, `"urban"` setting, or from `"all"` settings.
23+
- `data_source`, which indicates if the data should be extracted from Prem et
24+
al. (2017) or Prem et al. (2021)
25+
126
# contactdata 0.2
227

328
* Addition of a new function `age_df_countries()` to get population

0 commit comments

Comments
 (0)