Expand on meaning of infinite in borel functions

epiverse-trace · Mar 21, 2024 · 1b1e9de · 1b1e9de
1 parent 625f580
commit 1b1e9de
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/R/borel.r b/R/borel.r
@@ -27,8 +27,12 @@ dborel <- function(x, mu, log = FALSE) {
 ##' Random numbers are generated by simulating from a Poisson branching process
 ##' @param n Number of random variates to generate.
 ##' @inheritParams dborel
-##' @param infinite Any number to treat as infinite; simulations will be
-##' stopped if this number is reached
+##' @param infinite A threshold above which the random number is set to
+##'  `Inf` as a form of truncation. This is important because `rborel()` uses
+##'  `simulate_summary()` internally with `offspring_dist = rpois`, so
+##'  when `mu >= 1`, the simulation could grow out of proportion and chain
+##'  summaries (the random numbers generated here) need to be truncated using
+##'  `infinite`.
 ##' @return Vector of random numbers
 ##' @author Sebastian Funk
 ##' @export

diff --git a/man/rborel.Rd b/man/rborel.Rd
diff --git a/man/rgborel.Rd b/man/rgborel.Rd