Skip to content
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

docs: improve strange wording on getting started page #292

Merged
merged 1 commit into from
Aug 29, 2024
Merged

docs: improve strange wording on getting started page #292

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 4 additions & 18 deletions vignettes/epidatr.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ pub_covidcast(
)
```

We can fetch a subset of states by listing out the desired locations:
Alternatively, we can fetch the full time series for a subset of states by
listing out the desired locations in the `geo_value` argument and using `*`
in the `time_values` argument:

```{r, eval = FALSE}
# Obtain the most up-to-date version of the smoothed covid-like illness (CLI)
Expand All @@ -128,24 +130,8 @@ pub_covidcast(
geo_type = "state",
time_type = "day",
geo_values = c("pa", "ca", "fl"),
time_values = epirange(20210105, 20210410)
)
```

We can also request data for a single location at a time, via the `geo_values` argument.

```{r}
# Obtain the most up-to-date version of the smoothed covid-like illness (CLI)
# signal from the COVID-19 Trends and Impact survey for Pennsylvania
epidata <- pub_covidcast(
source = "fb-survey",
signals = "smoothed_cli",
geo_type = "state",
time_type = "day",
geo_values = "pa",
time_values = epirange(20210105, 20210410)
time_values = "*"
)
knitr::kable(head(epidata))
```

## Getting versioned data
Expand Down
Loading