Merge pull request #77 from cmu-delphi/ds/docs

Another documentation pass

Author: dshemetov

.Rbuildignore

@@ -15,4 +15,7 @@
 ^\.editorconfig$
 ^\.lintr$
 ^Makefile$
-
+^venv$
+^.venv$
+^env$
+^.env$

.gitignore

@@ -6,6 +6,10 @@
 docs
 inst/doc
 /check
-.Rdata
-.httr-oauth
 .DS_Store
+venv
+env
+.venv
+.env
+.Rdata
+.httr-oauth

DESCRIPTION

@@ -25,7 +25,7 @@ Imports:
   readr,
   MMWRweek,
   rlang
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3
 Suggests:
     knitr,
     magrittr,

R/endpoints.R

@@ -1,3 +1,12 @@
+#' an abstraction that holds the information needed to make an epidata call
+#'
+#' @param endpoint the epidata endpoint to call
+#' @param params the parameters to pass to the epidata endpoint
+#' @param meta meta data to attach to the epidata call
+#' @param only_supports_classic if true only classic format is supported
+#'
+#' @return an epidata_call instance
+#'
 create_epidata_call <- function(endpoint, params, meta = NULL,
                                 only_supports_classic = FALSE) {
   stopifnot(is.character(endpoint), length(endpoint) == 1)

R/epidatacall.R

@@ -1,7 +1,7 @@
 #' builds a new EpiRange instances
 #'
-#' @param from A string or numeric that takes the form YYYYMMDD.
-#' @param to A string or numeric that takes the form YYYYMMDD.
+#' @param from A string or numeric that takes the form YYYYMMDD for dates or YYYYMM for epiweeks.
+#' @param to A string or numeric that takes the form YYYYMMDD for dates or YYYYMM for epiweeks.
 #' @return EpiRange instance
 #'
 #' @export

R/model.R

@@ -6,7 +6,7 @@ format_item <- function(value) {
     "from" %in% names(value) && "to" %in% names(value) && length(names(value)) == 2) {
     paste0(toString(value$from), "-", toString(value$to))
   } else {
-    toString(value)
+    paste(value, collapse = ",")
   }
 }
 
@@ -16,5 +16,5 @@ format_list <- function(values) {
     ("from" %in% names(values) && "to" %in% names(values))) {
     values <- list(values)
   }
-  paste(sapply(values, format_item), collapse = ",")
+  paste(vapply(values, format_item, character(1L)), collapse = ",")
 }

R/utils.R

@@ -8,7 +8,10 @@ test_that("format_list", {
   expect_equal(format_list(5), "5")
   expect_equal(format_list("5"), "5")
   expect_equal(format_list(list(from = 2, to = 5)), "2-5")
+  expect_equal(format_list(list(list(from = 2, to = 6))), "2-6")
   expect_equal(format_list(epirange(2, 8)), "2-8")
+  expect_equal(format_list(list(epirange(2, 9))), "2-9")
   expect_equal(format_list(list("5", "4")), "5,4")
   expect_equal(format_list(list(3, list(from = 2, to = 5))), "3,2-5")
+  expect_equal(format_list(list(c(3, 8), list(from = 2, to = 5))), "3,8,2-5")
 })