Skip to content

Commit

Permalink
add link to database vignette in README
Browse files Browse the repository at this point in the history
  • Loading branch information
joshwlambert committed Jul 9, 2024
1 parent 30130cf commit be5bab3
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ epidists

This results a list of database entries. Each entry of the library is an `<epidist>` object.

Alternatively, the library of epiparameters can be viewed as a vignette locally (`vignette("database", package = "epiparameter")`) or on the [{epiparameter} website](https://epiverse-trace.github.io/epiparameter/articles/database.html).

The results can be filtered by disease and epidemiological distribution. Here we set `single_epidist = TRUE` as we only want a single database entry returned, and by default (`single_epidist = FALSE`) it will return all database entries that match the disease (`disease`) and epidemiological distribution (`epi_dist`).

```{r load-single-epidist}
Expand Down

0 comments on commit be5bab3

Please sign in to comment.