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

Better describe meaning/context of endpoints in documentation #233

Open
7 tasks
nmdefries opened this issue Jan 4, 2024 · 2 comments
Open
7 tasks

Better describe meaning/context of endpoints in documentation #233

nmdefries opened this issue Jan 4, 2024 · 2 comments

Comments

@nmdefries
Copy link
Contributor

These are really issues with lack of information in the Epidata doc website. We'll probably end up mirroring info from there, so will need to wait for those to be updated (project planned for this semester, maybe).

  • unclear what pub_covid_hosp_facility signal cols represent. There are covariance columns (names end with "_cov")??
  • what locations are allowed for pub_flusurv?
  • pub_ecdc_ili not clear what are valid region names. Example uses a (lowercase and unabbreviated) country name. online docs don't list allowed regions either, and is basically a stub.
  • pub_kcdc_ili not clear what are valid region names. Example uses a (uppercase and abbreviated) acronym -- unclear what it means. online docs don't list allowed regions either, and is basically a stub. Nowhere does it say what the KCDC is or link to any additional info
  • Private endpoints need more info about authorization required. Can non-Delphi users get access to the private endpoints? Why are they private?
  • hard to tell that pub_nidss_flu has non-US data, has Taiwanese data, and what the regions to request are
  • can't tell what pub_meta returns. What API? How is it different than pub_covidcast_meta? Docs and blurb in avail_endpoints need more fleshing out
@nmdefries nmdefries changed the title Improvements to endpoint documentation Better describe meaning/context of endpoints in documentation Jan 4, 2024
@nmdefries nmdefries mentioned this issue Jan 4, 2024
42 tasks
@nmdefries
Copy link
Contributor Author

From #212 (comment)

unclear what pub_covid_hosp_facility signal cols represent. There are covariance columns (names end with "_cov")??

_cov = "coverage", not "covariance". And "coverage" in some sense of % facilities reporting the corresponding non-_cov column or something like that. Would need to read upstream docs. I think they do just use that _cov naming upstream though, unfortunate.

@nmdefries nmdefries added this to the Z: epidatr & epidatpy milestone Jan 4, 2024
@nmdefries
Copy link
Contributor Author

Maybe good for @tinatownes to work on.

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

No branches or pull requests

1 participant