Add details about which offspring distributions are supported

epiverse-trace · Sep 4, 2023 · f827997 · f827997
1 parent ce1a990
commit f827997
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/R/simulate.r b/R/simulate.r
@@ -308,7 +308,10 @@ simulate_summary <- function(nchains, statistic = c("size", "length"),
 #' of each element), and `generation`.
 #' @details
 #'
-#' # Offspring models
+#' # Offspring distributions
+#' Currently only "pois" & "nbinom" are supported. Internally truncated
+#' distributions are used to avoid infecting more people than susceptibles
+#' available.
 #'
 #' The poisson model is parametrised so that:
 #'

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