Reword intvn_mean_reduction parameter documentation

epiverse-trace · Oct 2, 2023 · f164e12 · f164e12
1 parent 8f600f0
commit f164e12
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 20 deletions.
diff --git 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
diff --git a/man/simulate_summary.Rd b/man/simulate_summary.Rd
diff --git a/man/simulate_tree.Rd b/man/simulate_tree.Rd
diff --git a/man/simulate_tree_from_pop.Rd b/man/simulate_tree_from_pop.Rd