Skip to content

Simple documentation fixes #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Nov 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion R/covidcast.R
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
5 changes: 3 additions & 2 deletions R/endpoints.R
Original file line number Diff line number Diff line change
Expand Up @@ -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"
)
}

Expand Down
4 changes: 2 additions & 2 deletions R/epidatacall.R
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
26 changes: 13 additions & 13 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion man/covidcast_epidata.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions man/epidata_call.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.