metadata for sweep.SIR.models

mponce0 · Jul 24, 2020 · 82e4abe · 82e4abe
1 parent c21c6c9
commit 82e4abe
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/NEWS b/NEWS
@@ -1,5 +1,6 @@
 Jul 2020:
-	- Adding a new function, sweep.SIR.models for generating a range of values for R0 based on the starting date t0 to consider for the SIR model
+	- Adding a new function, sweep.SIR.models for generating a series of models based on a range for the starting date t0
+
 
 Jul 2020:  Several new features and bugs fixes _ ver 1.1.1
 		- added new geographical categories to select data per continents, implemented via geographicalRegions() fn

diff --git a/R/covid19_models.R b/R/covid19_models.R
@@ -430,9 +430,18 @@ sweep.SIR.models <- function(data=NULL, geo.loc="Hubei",
 			tfinal=90,
 			fatality.rate = 0.02,
 			tot.population=1400000000) {
-
+#'
 #' function to perform a sweep of models and generate values of R0
 #'
+#' @param  data  time series dataset to consider
+#' @param  geo.loc  country/region to analyze
+#' @param  t0_range  range of initial date for data consideration
+#' @param  t1  final period of time for data consideration
+#' @param  deltaT interval period of time from t0, ie. number of days to consider since t0
+#' @param  tfinal  total number of days
+#' @param  fatality.rate  rate of causality, deafault value of 2 percent
+#' @param  tot.population  total population of the country/region
+#'
 #' @export
 #'
 #' @examples