Skip to content

Commit

Permalink
fixed spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
joshwlambert committed Jun 4, 2024
1 parent 4252241 commit 9141033
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion vignettes/design_principles.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Other functions return the simplest type possible, this may be an atomic vector

* The conversion functions are designed to have a single function exported to the user for summary statistics to parameters, and another function exported for parameters to summary statistics. These functions use a `switch()` to dispatch to the internal conversion functions. This provides a minimal number of conversion functions in the package namespace compared to exporting a conversion function for every distribution.

* If there are a large number of entries returned when reading epidemiological parameters from the library using the `epidist_db()` function, it can flood the console, due to the default `list` printing in R. This is the reasoning for the `<multi_epidist>` object which is a minimal class to enable cleaner and more descriptive printing for a large list of `<epidist>` objects. The `print.multi_epidist()` prints a header with metadata on the number of `<epidist>` objects and numbr of diseases and epidemiological distributions in the list. It also lists all the diseases and epidemiological parameters returned. The footer of the `print()` function states the number of `<epidist>` objects not shown, guides to use `print(n = ...)` and `parameter_tbl()` and a link to the online database vignette (`database.Rmd`). Information in the header and footer considered metadata or advice is prefixed with `#`.
* If there are a large number of entries returned when reading epidemiological parameters from the library using the `epidist_db()` function, it can flood the console, due to the default `list` printing in R. This is the reasoning for the `<multi_epidist>` object which is a minimal class to enable cleaner and more descriptive printing for a large list of `<epidist>` objects. The `print.multi_epidist()` prints a header with metadata on the number of `<epidist>` objects and number of diseases and epidemiological distributions in the list. It also lists all the diseases and epidemiological parameters returned. The footer of the `print()` function states the number of `<epidist>` objects not shown, guides to use `print(n = ...)` and `parameter_tbl()` and a link to the online database vignette (`database.Rmd`). Information in the header and footer considered metadata or advice is prefixed with `#`.

## Dependencies

Expand Down

0 comments on commit 9141033

Please sign in to comment.