add examples to sim_* documentation of using argument defaults, WIP #120

R/sim_contacts.R

@@ -12,7 +12,12 @@
 #' @author Joshua W. Lambert, Carmen Tamayo
 #'
 #' @examples
-#' # load data required to simulate contacts
+#' # quickly simulate contact tracing data using the function defaults
+#' contacts <- sim_contacts()
+#' head(contacts)
+#'
+#' # to simulate more realistic contact tracing data load epiparameters from
+#' # {epiparameter}
 #' contact_distribution <- epiparameter::epidist(
 #'   disease = "COVID-19",
 #'   epi_dist = "contact distribution",

R/sim_linelist.R

@@ -96,7 +96,12 @@
 #' @author Joshua W. Lambert, Carmen Tamayo
 #'
 #' @examples
-#' # load data required to simulate line list
+#' # quickly simulate a line list using the function defaults
+#' linelist <- sim_linelist()
+#' head(linelist)
+#'
+#' # to simulate a more realistic line list load epiparameters from
+#' # {epiparameter}
 #' contact_distribution <- epiparameter::epidist(
 #'   disease = "COVID-19",
 #'   epi_dist = "contact distribution",

R/sim_outbreak.R

@@ -17,7 +17,13 @@
 #' @author Joshua W. Lambert
 #'
 #' @examples
-#' # load data required to simulate outbreak data
+#' # quickly simulate an outbreak using the function defaults
+#' outbreak <- sim_outbreak()
+#' head(outbreak$linelist)
+#' head(outbreak$contacts)
+#'
+#' # to simulate a more realistic outbreak load epiparameters from
+#' # {epiparameter}
 #' contact_distribution <- epiparameter::epidist(
 #'   disease = "COVID-19",
 #'   epi_dist = "contact distribution",