add example to documentation of vip_population

mrc-ide · Feb 8, 2024 · 8f767df · 8f767df
1 parent 012256c
commit 8f767df
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/R/vip_population.R b/R/vip_population.R
@@ -29,6 +29,13 @@
 ##'     respectively, throughout the whole population.
 ##' @export
 ##' @author Tini Garske
+##' @examples
+##' pop <- vip_population(region = "UK", year_min = 2000, year_max = 2010)
+##'
+##' pop <- vip_population(region = c("FRA", "UK"),
+##'                       year_min = 2000, year_max = 2010,
+##'                       age_min = 0, age_max = 80)
+##'
 vip_population <- function(region = character(),
                            year_min = integer(), year_max = integer(),
                            age_min = 0, age_max = 100) {

diff --git a/man/vip_population.Rd b/man/vip_population.Rd