Skip to content

Commit

Permalink
updated epidist_db documentation, relates #163
Browse files Browse the repository at this point in the history
  • Loading branch information
joshwlambert committed Aug 23, 2023
1 parent 3dcc49f commit 0a11238
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions R/epidist_db.R
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@
#' (and `author` if specified). If left as `NULL` (default) no subsetting is
#' carried out.
#'
#' The expression can be specified without using the data object name
#' (e.g. `df$var`) and instead just `var` can be supplied (see details). In
#' The expression should be specified without using the data object name
#' (e.g. `df$var`) and instead just `var` should be supplied. In
#' other words, this argument works the same as the `subset` argument in
#' [`subset()`]. It is similar to `<data-masking>` using by the `dplyr` package.
#'
Expand Down Expand Up @@ -101,6 +101,7 @@ epidist_db <- function(disease,
author = NULL,
subset = NULL,
single_epidist = FALSE) {
browser()
# check input
checkmate::assert_string(disease)
epi_dist <- match.arg(arg = epi_dist, several.ok = FALSE)
Expand Down
4 changes: 2 additions & 2 deletions man/epidist_db.Rd

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

0 comments on commit 0a11238

Please sign in to comment.