Skip to content

Documentation update pass #23

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.

Sign up for GitHub

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 6 commits into from
Oct 25, 2022
Merged

Documentation update pass #23

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
11dd979
Endpoints and covidcast_epidata documentation pass
dshemetov Mar 31, 2022
8634ab7
Re-`document()`
lcbrooks Oct 19, 2022
adac505
Don't test some long-running examples pending backend resolutions
lcbrooks Oct 25, 2022
7503c38
Re-`style_pkg()`
lcbrooks Oct 25, 2022
fc76084
Re-`style_pkg()` with newer `styler`
lcbrooks Oct 25, 2022
66578ee
Merge branch 'dev' into ds/doc-updates
lcbrooks Oct 25, 2022
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
13 changes: 12 additions & 1 deletion R/covidcast.R
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,18 @@ print.covidcast_data_source <- function(source, ...) {

#' creates the covidcast epidata helper
#'
#' @param base_url optional alternative base url
#' Creates a helper object that can use auto-complete to help find covidcast
#' sources and signals.
#'
#' @examples
#' covidcast_api <- covidcast_epidata()
#' print(covidcast_api) # print available sources and signals
#' fb_survey <- covidcast_api$sources$`fb-survey` # tab completion for sources
#' print(fb_survey) # print a verbose list of available signals
#' smoothed_cli <- fb_survey$signals$smoothed_cli # tab completion for signals
#' print(smoothed_cli)
#' df <- smoothed_cli$call("nation", "us", epirange(20210405, 20210410))
#' @param base_url optional alternative API base url
#' @importFrom httr RETRY stop_for_status content
#' @importFrom jsonlite fromJSON
#' @return an instance of covidcast_epidata
Expand Down
Loading