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 dashboard signal documentation #1341

Open
melange396 opened this issue Nov 8, 2023 · 3 comments
Open

Update dashboard signal documentation #1341

melange396 opened this issue Nov 8, 2023 · 3 comments
Assignees
Labels
chore documentation user experience things that affect users of our software or services

Comments

@melange396
Copy link
Collaborator

Make markdown table at

| Public Behavior | People Wearing Masks | [`fb-survey`](covidcast-signals/fb-survey.md) | `smoothed_wwearing_mask_7d` |
| Public Behavior | Vaccine Acceptance | [`fb-survey`](covidcast-signals/fb-survey.md) | `smoothed_wcovid_vaccinated_appointment_or_accept` |
| Public Behavior | COVID Symptom Searches on Google | [`google-symptoms`](covidcast-signals/google-symptoms.md) | `sum_anosmia_ageusia_smoothed_search` |
| Early Indicators | COVID-Like Symptoms | [`fb-survey`](covidcast-signals/fb-survey.md) | `smoothed_wcli` |
| Early Indicators | COVID-Like Symptoms in Community | [`fb-survey`](covidcast-signals/fb-survey.md) | `smoothed_whh_cmnty_cli` |
| Early Indicators | COVID-Related Doctor Visits | [`doctor-visits`](covidcast-signals/doctor-visits.md) | `smoothed_adj_cli` |
| Cases and Testing | COVID Cases | [`jhu-csse`](covidcast-signals/jhu-csse.md) | `confirmed_7dav_incidence_prop` |
| Late Indicators | COVID Hospital Admissions | [`hhs`](covidcast-signals/hhs.md) | `confirmed_admissions_covid_1d_prop_7dav` |
| Late Indicators | Deaths | [`jhu-csse`](covidcast-signals/jhu-csse.md) | `deaths_7dav_incidence_prop` |
match the current state in https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/server/endpoints/covidcast_utils/descriptions.raw.txt, after recent changes to it in #1334 and #1335, and probably older modifications as well.

@BrainIsDead
Copy link
Contributor

@melange396 could you pls describe a bit more detail this task

@melange396
Copy link
Collaborator Author

@BrainIsDead There is a table in docs/api/covidcast_signals.md that has (or at least is supposed to have) information for the signals shown on the public COVIDcast dashboard. The signals shown are actually controlled by the contents of src/server/endpoints/covidcast_utils/descriptions.raw.txt. Changes have been made to descriptions.raw.txt (signals have been added and removed as in #1334 and #1335) but the list of signals in covidcast_signals.md was not updated to match.

@melange396
Copy link
Collaborator Author

Update: more changes to the referenced signals were done in cmu-delphi/www-covidcast#1264 (comment)

@melange396 melange396 added documentation chore user experience things that affect users of our software or services labels Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore documentation user experience things that affect users of our software or services
Projects
None yet
3 participants