diff --git a/R/intervention.R b/R/intervention.R index d14e3547..3ab7339c 100644 --- a/R/intervention.R +++ b/R/intervention.R @@ -9,10 +9,11 @@ #' argument. #' #' @inheritParams simulate_tree -#' @param intvn_mean_reduction Amount of reduction in the mean. A scalar -#' between 0 and 1. -#' It scales the mean of `offspring_dist`. `intvn_mean_reduction` = 0 implies -#' no intervention impact and `intvn_mean_reduction` = 1 implies full impact. +#' @param intvn_mean_reduction A number between 0 +#' and 1 for scaling/reducing the mean of `offspring_dist`. Serves as +#' population-level intervention. `intvn_mean_reduction` = 0 +#' implies no intervention impact and `intvn_mean_reduction` = 1 implies full +#' impact. #' @param pars_list Parameter(s) for poisson or negative binomial offspring #' distribution. #' @return List of the offspring distribution parameter(s) with the mean diff --git a/man/intvn_reduce_mean.Rd b/man/intvn_reduce_mean.Rd index 9ae20db7..080ec2a9 100644 --- a/man/intvn_reduce_mean.Rd +++ b/man/intvn_reduce_mean.Rd @@ -7,10 +7,11 @@ intvn_reduce_mean(intvn_mean_reduction, offspring_dist, pars_list) } \arguments{ -\item{intvn_mean_reduction}{Amount of reduction in the mean. A scalar -between 0 and 1. -It scales the mean of \code{offspring_dist}. \code{intvn_mean_reduction} = 0 implies -no intervention impact and \code{intvn_mean_reduction} = 1 implies full impact.} +\item{intvn_mean_reduction}{A number between 0 +and 1 for scaling/reducing the mean of \code{offspring_dist}. Serves as +population-level intervention. \code{intvn_mean_reduction} = 0 +implies no intervention impact and \code{intvn_mean_reduction} = 1 implies full +impact.} \item{offspring_dist}{Offspring distribution: a character string corresponding to the R distribution function (e.g., "pois" for Poisson, diff --git a/man/simulate_summary.Rd b/man/simulate_summary.Rd index d17a15b2..9c1283af 100644 --- a/man/simulate_summary.Rd +++ b/man/simulate_summary.Rd @@ -29,10 +29,11 @@ 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{intvn_mean_reduction}{Amount of reduction in the mean. A scalar -between 0 and 1. -It scales the mean of \code{offspring_dist}. \code{intvn_mean_reduction} = 0 implies -no intervention impact and \code{intvn_mean_reduction} = 1 implies full impact.} +\item{intvn_mean_reduction}{A number between 0 +and 1 for scaling/reducing the mean of \code{offspring_dist}. Serves as +population-level intervention. \code{intvn_mean_reduction} = 0 +implies no intervention impact and \code{intvn_mean_reduction} = 1 implies full +impact.} \item{stat_max}{A cut off for the chain statistic (size/length) being computed. Results above the specified value, are set to \code{Inf}.} diff --git a/man/simulate_tree.Rd b/man/simulate_tree.Rd index 699d75fd..cb3d0629 100644 --- a/man/simulate_tree.Rd +++ b/man/simulate_tree.Rd @@ -36,10 +36,11 @@ numbers).} computed. Results above the specified value, are set to this value. Defaults to \code{Inf}.} -\item{intvn_mean_reduction}{Amount of reduction in the mean. A scalar -between 0 and 1. -It scales the mean of \code{offspring_dist}. \code{intvn_mean_reduction} = 0 implies -no intervention impact and \code{intvn_mean_reduction} = 1 implies full impact.} +\item{intvn_mean_reduction}{A number between 0 +and 1 for scaling/reducing the mean of \code{offspring_dist}. Serves as +population-level intervention. \code{intvn_mean_reduction} = 0 +implies no intervention impact and \code{intvn_mean_reduction} = 1 implies full +impact.} \item{serials_dist}{The serial interval distribution function; the name of a user-defined named or anonymous function with only one argument \code{n}, diff --git a/man/simulate_tree_from_pop.Rd b/man/simulate_tree_from_pop.Rd index 84cc079d..030f9fe8 100644 --- a/man/simulate_tree_from_pop.Rd +++ b/man/simulate_tree_from_pop.Rd @@ -24,10 +24,11 @@ corresponding to the R distribution function (e.g., "pois" for Poisson, where \code{\link{rpois}} is the R function to generate Poisson random numbers). Only supports "pois" and "nbinom".} -\item{intvn_mean_reduction}{Amount of reduction in the mean. A scalar -between 0 and 1. -It scales the mean of \code{offspring_dist}. \code{intvn_mean_reduction} = 0 implies -no intervention impact and \code{intvn_mean_reduction} = 1 implies full impact.} +\item{intvn_mean_reduction}{A number between 0 +and 1 for scaling/reducing the mean of \code{offspring_dist}. Serves as +population-level intervention. \code{intvn_mean_reduction} = 0 +implies no intervention impact and \code{intvn_mean_reduction} = 1 implies full +impact.} \item{serials_dist}{The serial interval distribution function; the name of a user-defined named or anonymous function with only one argument \code{n},