From 39f5d36d2393f38c4dd79bbf54e5bc96685db849 Mon Sep 17 00:00:00 2001 From: Joshua Lambert Date: Wed, 1 May 2024 10:36:33 +0100 Subject: [PATCH] update proportion_transmission simulate arg doc, closes #94 --- DESCRIPTION | 2 +- R/proportion_transmission.R | 3 ++- man/proportion_transmission.Rd | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index af750ac..c74223b 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -53,7 +53,7 @@ URL: https://github.com/epiverse-trace/superspreading, https://epiverse-trace.gi BugReports: https://github.com/epiverse-trace/superspreading/issues Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.1 Imports: checkmate, stats, diff --git a/R/proportion_transmission.R b/R/proportion_transmission.R index 5f218e9..b0301ed 100644 --- a/R/proportion_transmission.R +++ b/R/proportion_transmission.R @@ -21,7 +21,8 @@ #' @param percent_transmission A `number` of the percentage transmission #' for which a proportion of cases has produced. #' @param simulate A `logical` whether the calculation should be done -#' numerically (i.e. simulate secondary contacts) or analytically. +#' numerically (i.e. simulate secondary contacts) or analytically. Default is +#' `FALSE` which uses the analytical calculation. #' #' @return A `` with the value for the proportion of cases for a #' given value of R and k. diff --git a/man/proportion_transmission.Rd b/man/proportion_transmission.Rd index 620878b..d704c92 100644 --- a/man/proportion_transmission.Rd +++ b/man/proportion_transmission.Rd @@ -26,7 +26,8 @@ offspring distribution from fitted negative binomial).} for which a proportion of cases has produced.} \item{simulate}{A \code{logical} whether the calculation should be done -numerically (i.e. simulate secondary contacts) or analytically.} +numerically (i.e. simulate secondary contacts) or analytically. Default is +\code{FALSE} which uses the analytical calculation.} \item{...}{\link{dots} not used, extra arguments supplied will cause a warning.}