From ba6b82f87660854f39b3f7d09d183faacc26e9ff Mon Sep 17 00:00:00 2001 From: jamesaazam Date: Mon, 4 Sep 2023 22:17:29 +0100 Subject: [PATCH] Redocument offspring_dist by inheriting the argument --- man/get_offspring_func.Rd | 8 ++++---- man/simulate_tree_from_pop.Rd | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/man/get_offspring_func.Rd b/man/get_offspring_func.Rd index b5ff6ba5..15a28e90 100644 --- a/man/get_offspring_func.Rd +++ b/man/get_offspring_func.Rd @@ -15,10 +15,10 @@ get_offspring_func( ) } \arguments{ -\item{offspring_dist}{Offspring distribution sampler: a character string -corresponding to the R distribution function. Currently only "pois" & -"nbinom" are supported. Internally truncated distributions are used to -avoid infecting more people than susceptibles available.} +\item{offspring_dist}{Offspring distribution: a character string +corresponding to the R distribution function (e.g., "pois" for Poisson, +where \code{\link{rpois}} is the R function to generate Poisson random +numbers).} \item{n}{Number of items to sample} diff --git a/man/simulate_tree_from_pop.Rd b/man/simulate_tree_from_pop.Rd index 019efc27..c7cecd3b 100644 --- a/man/simulate_tree_from_pop.Rd +++ b/man/simulate_tree_from_pop.Rd @@ -19,10 +19,10 @@ simulate_tree_from_pop( \arguments{ \item{pop}{The susceptible population.} -\item{offspring_dist}{Offspring distribution sampler: a character string -corresponding to the R distribution function. Currently only "pois" & -"nbinom" are supported. Internally truncated distributions are used to -avoid infecting more people than susceptibles available.} +\item{offspring_dist}{Offspring distribution: a character string +corresponding to the R distribution function (e.g., "pois" for Poisson, +where \code{\link{rpois}} is the R function to generate Poisson random +numbers).} \item{offspring_mean}{The average number of secondary cases for each case. Same as R0.}