Merge pull request #27 from cmu-delphi/ds/lint-pass

Minor lints

Author: dshemetov

R/check.R

@@ -11,7 +11,7 @@ check_string_param <- function(name, value, required = TRUE) {
 }
 
 check_int_param <- function(name, value, required = TRUE) {
-  # string or string[]
+  # numeric or numeric[]
   if ((required &&
     !(!is.null(value) &&
       is.numeric(value))) ||
@@ -23,24 +23,24 @@ check_int_param <- function(name, value, required = TRUE) {
 }
 
 is_epirange_like <- function(value) {
+  # character or numeric or EpiRange or list(from=..., to=...)
   is.character(value) ||
     is.numeric(value) ||
     inherits(value, "EpiRange") ||
     (is.list(value) &&
       "from" %in% names(value) && "to" %in% names(value))
 }
 
-check_single_epirange_param <-
-  function(name, value, required = TRUE) {
-    if ((required &&
-      !(!is.null(value) &&
-        is_epirange_like(value))) ||
-      (!required && !(is.null(value) || is_epirange_like(value)))) {
-      rlang::abort(paste0("argument ", name, " is not a epirange"),
-        name = name, value = value, class = "invalid_argument"
-      )
-    }
+check_single_epirange_param <- function(name, value, required = TRUE) {
+  if ((required &&
+    !(!is.null(value) &&
+      is_epirange_like(value))) ||
+    (!required && !(is.null(value) || is_epirange_like(value)))) {
+    rlang::abort(paste0("argument ", name, " is not a epirange"),
+      name = name, value = value, class = "invalid_argument"
+    )
   }
+}
 
 check_epirange_param <- function(name, value, required = TRUE) {
   if (is.null(value)) {

R/constants.R

@@ -1,5 +1,3 @@
-
-
 version <- "1.0.0"
 http_headers <- httr::add_headers("User-Agent" = paste0("delphi_epidata", version))
 global_base_url <- "https://delphi.cmu.edu/epidata/"

R/covidcast.R

@@ -1,9 +1,7 @@
-
 parse_signal <- function(signal, base_url) {
   class(signal) <- c("covidcast_data_signal", class(signal))
   signal$key <- paste(signal$source, signal$signal, sep = ":")
 
-  #'
   #' fetch covidcast data
   #'
   #' @param data_source data source to fetch
@@ -48,7 +46,6 @@ parse_source <- function(source, base_url) {
   r
 }
 
-
 as.data.frame.covidcast_data_signal_list <- function(signals, ...) {
   as.data.frame(do.call(rbind, lapply(signals, function(x) {
     sub <- x[c(
@@ -77,7 +74,6 @@ as.data.frame.covidcast_data_signal_list <- function(signals, ...) {
   }), ...)
 }
 
-
 print.covidcast_data_source <- function(source, ...) {
   print(source$name, ...)
   print(source$source, ...)
@@ -86,13 +82,11 @@ print.covidcast_data_source <- function(source, ...) {
   print(signals[, c("signal", "name", "short_description")], ...)
 }
 
-#'
 #' creates the covidcast epidata helper
 #'
 #' @param base_url optional alternative base url
 #' @importFrom httr RETRY stop_for_status content
 #' @importFrom jsonlite fromJSON
-#' @importFrom rlang abort
 #' @return an instance of covidcast_epidata
 #'
 #' @export
@@ -122,7 +116,6 @@ covidcast_epidata <- function(base_url = global_base_url) {
   )
 }
 
-
 as.data.frame.covidcast_data_source_list <- function(sources, ...) {
   as.data.frame(do.call(rbind, lapply(sources, function(x) {
     sub <- x[c(

R/epidatacall.R

@@ -1,6 +1,3 @@
-
-
-
 create_epidata_call <- function(endpoint, params, meta = NULL,
                                 only_supports_classic = FALSE) {
   stopifnot(is.character(endpoint), length(endpoint) == 1)
@@ -22,7 +19,6 @@ create_epidata_call <- function(endpoint, params, meta = NULL,
   )
 }
 
-#'
 #' use a different base url
 #'
 #' @param epidata_call and instance of epidata_call
@@ -66,7 +62,6 @@ full_url <- function(epidata_call) {
   join_url(epidata_call$base_url, epidata_call$endpoint)
 }
 
-#'
 #' returns the full request url for the given epidata_call
 #'
 #' @param epidata_call and instance of epidata_call
@@ -99,7 +94,6 @@ request_impl <- function(epidata_call, format_type, fields = NULL) {
   do_request(url, params)
 }
 
-#'
 #' fetches the data and returns the classic format
 #'
 #' @param epidata_call and instance of epidata_call
@@ -128,7 +122,6 @@ fetch_classic <- function(epidata_call, fields = NULL, disable_date_parsing = FA
   m
 }
 
-#'
 #' fetches the data and returns the josn format
 #'
 #' @param epidata_call and instance of epidata_call
@@ -156,7 +149,6 @@ fetch_json <- function(epidata_call, fields = NULL, disable_date_parsing = FALSE
   parse_data_frame(epidata_call, jsonlite::fromJSON(r), disable_date_parsing = disable_date_parsing)
 }
 
-#'
 #' fetches the data and returns the CSV text
 #'
 #' @param epidata_call and instance of epidata_call
@@ -215,7 +207,6 @@ info_to_type <- function(info, disable_date_parsing = FALSE) {
   r
 }
 
-#'
 #' fetches the data and returns data frame
 #'
 #' @param epidata_call and instance of epidata_call
@@ -269,8 +260,6 @@ fetch_tbl <- function(epidata_call, fields = NULL, disable_date_parsing = FALSE)
   tbl
 }
 
-
-#'
 #' fetches the data and returns data frame
 #'
 #' @param epidata_call and instance of epidata_call

R/model.R

@@ -1,6 +1,3 @@
-
-
-#'
 #' builds a new EpiRange instances
 #'
 #' @param from start
@@ -21,36 +18,35 @@ epirange <- function(from, to) {
   structure(list(from = from, to = to), class = "EpiRange")
 }
 
-create_epidata_field_info <-
-  function(name,
-           type,
-           description = "",
-           categories = c()) {
-    stopifnot(is.character(name) && length(name) == 1)
-    stopifnot(
-      is.character(type) &&
-        length(type) == 1 &&
-        type %in% c(
-          "text",
-          "int",
-          "float",
-          "date",
-          "epiweek",
-          "categorical",
-          "bool"
-        )
-    )
-    stopifnot(is.character(description) && length(description) == 1)
-    structure(
-      list(
-        name = name,
-        type = type,
-        description = description,
-        categories = categories
-      ),
-      class = "EpidataFieldInfo"
-    )
-  }
+create_epidata_field_info <- function(name,
+                                      type,
+                                      description = "",
+                                      categories = c()) {
+  stopifnot(is.character(name) && length(name) == 1)
+  stopifnot(
+    is.character(type) &&
+      length(type) == 1 &&
+      type %in% c(
+        "text",
+        "int",
+        "float",
+        "date",
+        "epiweek",
+        "categorical",
+        "bool"
+      )
+  )
+  stopifnot(is.character(description) && length(description) == 1)
+  structure(
+    list(
+      name = name,
+      type = type,
+      description = description,
+      categories = categories
+    ),
+    class = "EpidataFieldInfo"
+  )
+}
 
 parse_value <- function(info, value, disable_date_parsing = FALSE) {
   stopifnot(inherits(info, "EpidataFieldInfo"))

R/parse.R

@@ -1,11 +1,7 @@
-
 parse_api_date <- function(value) {
   as.Date(as.character(value), format = "%Y%m%d")
 }
 
-
-
-#'
 #' parses a week
 #' @importFrom MMWRweek MMWRweek2Date
 #' @return a date

R/request.R

@@ -5,7 +5,6 @@ join_url <- function(url, endpoint) {
   paste0(url, endpoint)
 }
 
-#'
 #' performs the request
 #' @importFrom httr RETRY
 do_request <- function(url, params) {

R/utils.R

@@ -1,5 +1,3 @@
-
-
 # Helper function to cast values and/or ranges to strings
 format_item <- function(value) {
   if (inherits(value, "EpiRange")) {