updated hosp_death_risk and non_hosp_death_risk documentation to incl…

…ude time-varying rates, relates #36
epiverse-trace · Apr 25, 2024 · 421b6fb · 421b6fb
1 parent 5188203
commit 421b6fb
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 14 deletions.
diff --git a/R/sim_linelist.R b/R/sim_linelist.R
@@ -53,13 +53,17 @@
 #' specific hospitalised death risks Default is 50% death risk in hospitals
 #' (`0.5`) for the entire population. If the `onset_to_death` argument is set
 #' to `NA` this argument should also be set to `NA`. See details and examples
-#' for more information.
+#' for more information. If a time-varying death risk is specified in the
+#' `config` the `hosp_death_risk` is interpreted as the maximum risk across
+#' the epidemic.
 #' @param non_hosp_death_risk Either a single `numeric` for the death risk for
 #' outside of hospitals across the population, or a `<data.frame>` with age
 #' specific death risks outside of hospitals. Default is 5% death risk outside
 #' of hospitals  (`0.05`) for the entire population. If the `onset_to_death`
 #' argument is set to `NA` this argument should also be set to `NA`. See
-#' details and examples for more information.
+#' details and examples for more information. If a time-varying death risk is
+#' specified in the `config` the `non_hosp_death_risk` is interpreted as the
+#' maximum risk across the epidemic.
 #' @param outbreak_start_date A `date` for the start of the outbreak.
 #' @param add_names A `logical` boolean for whether to add names to each row
 #' of the line list. Default is `TRUE`.

diff --git a/man/dot-add_date.Rd b/man/dot-add_date.Rd
diff --git a/man/dot-check_sim_input.Rd b/man/dot-check_sim_input.Rd
diff --git a/man/dot-cross_check_sim_input.Rd b/man/dot-cross_check_sim_input.Rd
diff --git a/man/dot-sim_internal.Rd b/man/dot-sim_internal.Rd
diff --git a/man/sim_linelist.Rd b/man/sim_linelist.Rd
diff --git a/man/sim_outbreak.Rd b/man/sim_outbreak.Rd