Add documentation for susc. to example

Co-authored-by: Hugo Gruson <[email protected]>
epiverse-trace · Oct 28, 2022 · c4ca7ea · c4ca7ea
1 parent a7b7bd8
commit c4ca7ea
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/R/final_size.R b/R/final_size.R
@@ -77,6 +77,7 @@
 #'   data = 1, nrow = n_demo_grps, ncol = n_risk_grps
 #' )
 #' psusc <- psusc / rowSums(psusc)
+#' # In this example, all risk groups from all age groups are completely susceptible
 #' susc <- matrix(
 #'   data = 1, nrow = n_demo_grps, ncol = n_risk_grps
 #' )