Merge pull request #214 from cmu-delphi/ndefries/documentation1

Simple documentation fixes

Author: nmdefries

R/covidcast.R

@@ -127,7 +127,7 @@ print.covidcast_data_source <- function(x, ...) {
 #' ```
 #'
 #' These objects can be used directly to fetch data, without requiring us to use
-#' the `covidcast()` function. Simply use the `$call` attribute of the object:
+#' the `pub_covidcast()` function. Simply use the `$call` attribute of the object:
 #'
 #' ```{r}
 #' epidata$signals$`fb-survey:smoothed_cli`$call("state", "pa",

R/endpoints.R

@@ -717,10 +717,11 @@ pub_covidcast <- function(
       missing(signals) ||
       missing(time_type) ||
       missing(geo_type) ||
-      missing(time_values) || missing(geo_values)
+      missing(time_values) ||
+      missing(geo_values)
   ) {
     stop(
-      "`source`, `signals`, `time_type`, `geo_type`, `time_values`, and `geo_value` are all required"
+      "`source`, `signals`, `time_type`, `geo_type`, `time_values`, and `geo_values` are all required"
     )
   }
 

R/epidatacall.R

@@ -6,8 +6,8 @@
 #' `epidata_call` objects are generated internally by endpoint functions like
 #'   [`pub_covidcast`]; by default, they are piped directly into the `fetch`
 #'   function to fetch and format the data. For most endpoints this will return
-#'   a tibble, but a few non-COVIDCAST endpoints only support will return a
-#'   JSON-like list instead.
+#'   a tibble, but a few non-COVIDCAST endpoints will return a JSON-like list
+#'   instead.
 #'
 #' @details
 #' `create_epidata_call` is the constructor for `epidata_call` objects, but you

_pkgdown.yml

@@ -33,32 +33,32 @@ home:
       href: https://cmu-delphi.github.io/epidatasets/
 
 reference:
+  - title: Data source and signal discovery
+    desc: Quickly explore endpoints, and API signal and source names
+  - contents:
+      - avail_endpoints
+      - covidcast_epidata
+  - title: Make API requests
+    desc: Query Delphi Epidata endpoints
+  - contents:
+      - epidata_call
+      - fetch_args_list
+      - has_keyword("endpoint")
+      - -starts_with("pvt_")
   - title: Configuration and utilities
     desc: Set API keys and handle API data types
   - contents:
       - get_api_key
-      - avail_endpoints
       - epirange
       - timeset
-  - title: Control Caching behavior
+  - title: Control caching behavior
     desc: Configure an optional persistent cache
   - contents:
       - set_cache
       - clear_cache
       - disable_cache
       - cache_info
-  - title: Make API requests
-    desc: Query Delphi Epidata endpoints
-  - contents:
-      - epidata_call
-      - fetch_args_list
-      - has_keyword("endpoint")
-      - -starts_with("pvt_")
   - title: Make requests to private API endpoints
     desc: These endpoints require additional authorization to use
   - contents:
       - starts_with("pvt_")
-  - title: Autocomplete helpers
-    desc: Objects that can autocomplete API signals names for faster exploration
-  - contents:
-      - covidcast_epidata