update proportion_transmission simulate arg doc, closes #94

epiverse-trace · May 1, 2024 · 39f5d36 · 39f5d36
1 parent 4549ff9
commit 39f5d36
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git 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
@@ -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 `<data.frame>` 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