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.

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

Add code examples to other endpoint pages (and maybe also covidcast pages?) #1520

Open
nmdefries opened this issue Aug 16, 2024 · 0 comments

Comments

@nmdefries
Copy link
Contributor

Because the non-COVIDcast endpoints have different formats and are generally poorly documented, it can be difficult to construct a working API query. To help users get started, we could include example fetch code on each endpoint doc page, like

library(epidatr)
res <- pub_fluview(
  regions = c("nat", paste0("hhs", 1:10)),
  epiweeks = epirange(201040, 201940)
)

Alternatively, to avoid having example code in many places (makes maintenance more difficult), we could link to the corresponding epidatr/epidatpy documentation page for that endpoint's function. So the fluview page could link to here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant