Skip to content

Commit

Permalink
Update NEWS, .lintr, and fix line lengths
Browse files Browse the repository at this point in the history
  • Loading branch information
pratikunterwegs committed Sep 11, 2024
1 parent 7d18fde commit 269a70e
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
3 changes: 2 additions & 1 deletion .lintr
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ exclusions: list(
),
"R/class_country.R" = list(
duplicate_argument_linter = Inf, # due to cli_bullets
object_name_linter = Inf # due to S3 method
object_name_linter = Inf, # due to S3 method
object_length_linter = Inf # due to length of method name
),
"tests/testthat.R" = list(
unused_import_linter = Inf
Expand Down
12 changes: 6 additions & 6 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# daedalus 0.0.5

This patch adds the `<country>` class to represent country and territory data for `daedalus()`. Access, assignment, and print methods are also added, in addition to internal helpers such as `as_country()`. The class is tested with newly added tests.
This patch adds the `<daedalus_country>` class to represent country and territory data for `daedalus()`. Access, assignment, and print methods are also added, in addition to internal helpers such as `as_daedalus_country()`. The class is tested with newly added tests.

Other changes:

1. Adds the generic functions `get_data()`, `set_data()` and `prepare_parameters()`, with methods for `<country>` objects. Methods for infection data are also anticipated.
1. Adds the generic functions `get_data()`, `set_data()` and `prepare_parameters()`, with methods for `<daedalus_country>` objects. Methods for infection data are also anticipated.

2. Removes `make_country_parameters()` in favour of `prepare_parameters.country()`.
2. Removes `make_country_parameters()` in favour of `prepare_parameters.daedalus_country()`.

3. `daedalus()` expects its first argument to be a `<country>` and no longer accepts a `country_params_manual` argument; all changes to country parameters should be made via the class.
3. `daedalus()` accepts its first argument as either a country name or a `<daedalus_country>`, and no longer accepts a `country_params_manual` argument; all changes to country parameters should be made via the class.

4. `make_initial_state()` works on `<country>` objects instead of country names.
4. `make_initial_state()` works on `<daedalus_country>` objects instead of country names. Since this is an internal function it does not support passing a country string name.

5. Vignettes have been updated to use `<country>` objects.
5. Vignettes have been updated to show how to use `<daedalus_country>` objects.

# daedalus 0.0.4

Expand Down
2 changes: 1 addition & 1 deletion R/class_country.R
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ new_daedalus_country <- function(name, parameters) {
#' @export
#' @return
#'
#' - `daedalus_country()` returns an object of the S3 class `<daedalus_country>`.
#' - `daedalus_country()` returns an object of the S3 class `<daedalus_country>`
#'
#' - `is_daedalus_country()` returns a logical for whether an object is a
#' `<daedalus_country>`.
Expand Down
2 changes: 1 addition & 1 deletion man/class_country.Rd

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

0 comments on commit 269a70e

Please sign in to comment.