You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: vignettes/endpoints.Rmd
+32-32
Original file line number
Diff line number
Diff line change
@@ -27,28 +27,35 @@ Some endpoints allow for the use of `*` to access data at all locations. Check t
27
27
28
28
## COVIDcast Main Endpoint
29
29
30
-
All of these signals use the command `covidcast`, with variation in which source and signal are used.
30
+
All of these signals use the command `covidcast`, with variation in which source and signal are used.
31
31
32
32
Data Sources and Signals documentation: <https://cmu-delphi.github.io/delphi-epidata/api/covidcast_signals.html>
33
33
34
34
Function reference: <https://cmu-delphi.github.io/epidatr/reference/covidcast.html>
35
35
36
-
To understand the available sources better, use `covidcast_epidata()` and `covidcast_meta()`.
36
+
To understand the available sources better, use `covidcast_epidata()` and `covidcast_meta()`.
37
+
37
38
```{r}
38
39
covidcast_epidata()
39
40
```
41
+
40
42
For example, let's see what kind of smoothed signals come out of the [facebook survey](https://cmu-delphi.github.io/delphi-epidata/api/covidcast-signals/fb-survey.html) source:
County geo_values are [FIPS codes](https://en.wikipedia.org/wiki/List_of_United_States_FIPS_codes_by_county) and are discussed more here: <https://cmu-delphi.github.io/delphi-epidata/api/covidcast_geography.html>. The example above is for Orange County, California.
63
71
Since `covidcast` is an endpoint which supports `*`, here is an example of its use:
72
+
64
73
```{r}
65
74
covidcast(
66
75
data_source = "fb-survey",
@@ -81,6 +90,7 @@ API docs: <https://cmu-delphi.github.io/delphi-epidata/api/covid_hosp_facility_l
81
90
Function reference: <https://cmu-delphi.github.io/epidatr/reference/covid_hosp_facility_lookup.html>
These require private access keys to use. To actually run these locally, you will need to store these secrets in your `.Reviron` file, or set them as environmental variables.
265
285
266
-
### AFHSB metadata
267
-
268
-
API docs: <https://cmu-delphi.github.io/delphi-epidata/api/meta_afhsb.html>
269
-
270
-
Function reference: <https://cmu-delphi.github.io/epidatr/reference/pvt_meta_afhsb.html>
@@ -321,6 +314,7 @@ API docs: <https://cmu-delphi.github.io/delphi-epidata/api/ght.html>
321
314
Function reference: <https://cmu-delphi.github.io/epidatr/reference/pvt_ght.html>
322
315
323
316
Example call:
317
+
324
318
```{r, eval=FALSE}
325
319
pvt_ght(auth = Sys.getenv("SECRET_API_AUTH_GHT"), epiweeks = epirange(199301, 202304), locations = "ma", query = "how to get over the flu") %>% fetch_tbl()
326
320
```
@@ -332,6 +326,7 @@ API docs: <https://cmu-delphi.github.io/delphi-epidata/api/meta_norostat.html>
332
326
Function reference: <https://cmu-delphi.github.io/epidatr/reference/pvt_meta_norostat.html>
0 commit comments