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

Update client library documentation re. epidatr, other endpoints #1238

Open
brookslogan opened this issue Nov 13, 2023 · 0 comments · May be fixed by cmu-delphi/delphi-epidata#1422
Open

Update client library documentation re. epidatr, other endpoints #1238

brookslogan opened this issue Nov 13, 2023 · 0 comments · May be fixed by cmu-delphi/delphi-epidata#1422
Assignees
Labels
enhancement New feature or request

Comments

@brookslogan
Copy link

brookslogan commented Nov 13, 2023

It would be great if we could update the client library documentation

to reflect that

  • epidatr is now more mature and likely a better experience for fetching covidcast data than the covidcast R package, and
  • the delphi epidata clients offer data both from covidcast and from other "endpoints" of the API.

User story

A first-time user browses sequentially through the delphi-epidata docs, sees this page. Goal: they will understand epidatr is an option for accessing covidcast data. This may require some extra explanation though... epidatr is often faster at just fetching the data, presents it in a convenient tibble format, and has additional endpoints available, while covidcast has some side features that are not present in epidatr: pivoting, plotting, covidcast_metadata summarization, and population data.

A potential client package user may also google "covidcast api client" or "covidcast api package" or "covidcast package" and arrive here or here, and dismiss epidatr as not for covidcast data or not realizing that it exists.

Additional context

@XuedaShen flagged this as (i) it was unclear what the relationship between the covidcast and epidatr packages were, and (ii) it'd be useful to directly point users to epidatr on the covidcast clients page.

@brookslogan brookslogan added the enhancement New feature or request label Nov 13, 2023
@dshemetov dshemetov self-assigned this May 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants