Skip to content

Update Google Docs Meta Data #1622

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

Merged
merged 1 commit into from
Apr 1, 2025
Merged

Update Google Docs Meta Data #1622

merged 1 commit into from
Apr 1, 2025

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Mar 14, 2025

Updating Google Docs Meta Data

TL;DR:

  • 13 columns renamed
  • some clarifications in dsew-cpr names
  • google-symptoms name and description updates (mostly to include the "s0N codes in more places)
  • filled in some blank fields for nhsn

@melange396
Copy link
Collaborator

output from comparison code at #1612 (comment) :

column ordering changed!
added columns: ['Data Source', 'Data Use Terms', 'Demographic Breakdown', 'Geographic Coverage', 'Geographic Levels', 'Include in indicator app', 'Indicator Set', 'Indicator Type', 'Member API Name', 'Population', 'Surveillance Categories', 'Who may access this indicator?', 'Who may be told about this indicator?']
removed columns: ['Available Geography', 'Demographic Breakdowns', 'Demographic Scope', 'Geographic Scope', 'Include in signal app', 'License', 'Member Name', 'Severity Pyramid Rungs', 'Signal Set', 'Signal Type', 'Source Name', 'Who may access this signal?', 'Who may be told about this signal?']
# rows in dev file: 487
# rows in new file: 487
row count difference: 0
added signals: []
removed signals: []



MISMATCH!!  [ dsew-cpr : booster_doses_admin_7dav ]  dev row: 14 / new row: 14
  Name:
    COVID Vaccine Doses Administered
    -->
    COVID Vaccine Booster Doses Administered

MISMATCH!!  [ dsew-cpr : people_booster_doses ]  dev row: 19 / new row: 19
  Name:
    COVID Vaccine Doses Administered
    -->
    Number of people receiving COVID-19 vaccine booster doses

MISMATCH!!  [ google-symptoms : ageusia_raw_search ]  dev row: 349 / new row: 349
  Description:
    
    -->
    Google search volume for ageusia-related searches, in arbitrary units that are normalized for overall search users

MISMATCH!!  [ google-symptoms : anosmia_raw_search ]  dev row: 351 / new row: 351
  Description:
    
    -->
    Google search volume for anosmia-related searches, in arbitrary units that are normalized for overall search users 

MISMATCH!!  [ google-symptoms : s01_raw_search ]  dev row: 353 / new row: 355
  Short Description:
    The average relative frequency of searches for Cough, Phlegm, Sputum, and Upper respiratory tract infection, in arbitrary units that are normalized against overall search patterns within each region.
    -->
    The average relative frequency of searches for Cough, Phlegm, Sputum, and Upper respiratory tract infection, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s01)
  Description:
    The average relative frequency of searches for Cough, Phlegm, Sputum, and Upper respiratory tract infection, in arbitrary units that are normalized against overall search patterns within each region.The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
    -->
    The average relative frequency of searches for Cough, Phlegm, Sputum, and Upper respiratory tract infection, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s01)The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
  Name:
    Searches for: Cough, Phlegm, Sputum, Upper respiratory tract infection
    -->
    Searches for: Cough, Phlegm, Sputum, Upper respiratory tract infection (s01)

MISMATCH!!  [ google-symptoms : s01_smoothed_search ]  dev row: 354 / new row: 356
  Name:
    Searches for: Cough, Phlegm, Sputum, Upper respiratory tract infection (7-day average)
    -->
    Searches for: Cough, Phlegm, Sputum, Upper respiratory tract infection (s01) (7-day average)

MISMATCH!!  [ google-symptoms : s02_raw_search ]  dev row: 355 / new row: 357
  Short Description:
    The average relative frequency of searches for Nasal congestion, Post nasal drip, Rhinorrhea, Sinusitis, Rhinitis, and Common cold, in arbitrary units that are normalized against overall search patterns within each region.
    -->
    The average relative frequency of searches for Nasal congestion, Post nasal drip, Rhinorrhea, Sinusitis, Rhinitis, and Common cold, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s02)
  Description:
    The average relative frequency of searches for Nasal congestion, Post nasal drip, Rhinorrhea, Sinusitis, Rhinitis, and Common cold, in arbitrary units that are normalized against overall search patterns within each region.The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
    -->
    The average relative frequency of searches for Nasal congestion, Post nasal drip, Rhinorrhea, Sinusitis, Rhinitis, and Common cold, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s02)The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
  Name:
    Searches for: Nasal congestion, Post nasal drip, Rhinorrhea, Sinusitis, Rhinitis, Common cold
    -->
    Searches for: Nasal congestion, Post nasal drip, Rhinorrhea, Sinusitis, Rhinitis, Common cold (s02)

MISMATCH!!  [ google-symptoms : s02_smoothed_search ]  dev row: 356 / new row: 358
  Name:
    Searches for: Nasal congestion, Post nasal drip, Rhinorrhea, Sinusitis, Rhinitis, Common cold (7-day average)
    -->
    Searches for: Nasal congestion, Post nasal drip, Rhinorrhea, Sinusitis, Rhinitis, Common cold (s02) (7-day average)

MISMATCH!!  [ google-symptoms : s03_raw_search ]  dev row: 357 / new row: 359
  Short Description:
    The average relative frequency of searches for Fever, Hyperthermia, Chills, Shivering, and Low grade fever, in arbitrary units that are normalized against overall search patterns within each region.
    -->
    The average relative frequency of searches for Fever, Hyperthermia, Chills, Shivering, and Low grade fever, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s03)
  Description:
    The average relative frequency of searches for Fever, Hyperthermia, Chills, Shivering, and Low grade fever, in arbitrary units that are normalized against overall search patterns within each region.The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
    -->
    The average relative frequency of searches for Fever, Hyperthermia, Chills, Shivering, and Low grade fever, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s03)The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
  Name:
    Searches for: Fever, Hyperthermia, Chills, Shivering, Low grade fever
    -->
    Searches for: Fever, Hyperthermia, Chills, Shivering, Low grade fever (s03)

MISMATCH!!  [ google-symptoms : s03_smoothed_search ]  dev row: 358 / new row: 360
  Name:
    Searches for: Fever, Hyperthermia, Chills, Shivering, Low grade fever (7-day average)
    -->
    Searches for: Fever, Hyperthermia, Chills, Shivering, Low grade fever (s03) (7-day average)

MISMATCH!!  [ google-symptoms : s04_raw_search ]  dev row: 359 / new row: 361
  Short Description:
    The average relative frequency of searches for Shortness of breath, Wheeze, Croup, Pneumonia, Asthma, Crackles, Acute bronchitis, and Bronchitis, in arbitrary units that are normalized against overall search patterns within each region.
    -->
    The average relative frequency of searches for Shortness of breath, Wheeze, Croup, Pneumonia, Asthma, Crackles, Acute bronchitis, and Bronchitis, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s04)
  Description:
    The average relative frequency of searches for Shortness of breath, Wheeze, Croup, Pneumonia, Asthma, Crackles, Acute bronchitis, and Bronchitis, in arbitrary units that are normalized against overall search patterns within each region.The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
    -->
    The average relative frequency of searches for Shortness of breath, Wheeze, Croup, Pneumonia, Asthma, Crackles, Acute bronchitis, and Bronchitis, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s04)The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
  Name:
    Searches for: Shortness of breath, Wheeze, Croup, Pneumonia, Asthma, Crackles, Acute bronchitis, Bronchitis
    -->
    Searches for: Shortness of breath, Wheeze, Croup, Pneumonia, Asthma, Crackles, Acute bronchitis, Bronchitis (s04)

MISMATCH!!  [ google-symptoms : s04_smoothed_search ]  dev row: 360 / new row: 362
  Name:
    Searches for: Shortness of breath, Wheeze, Croup, Pneumonia, Asthma, Crackles, Acute bronchitis, Bronchitis (7-day average)
    -->
    Searches for: Shortness of breath, Wheeze, Croup, Pneumonia, Asthma, Crackles, Acute bronchitis, Bronchitis (s04) (7-day average)

MISMATCH!!  [ google-symptoms : s05_raw_search ]  dev row: 361 / new row: 363
  Short Description:
    The average relative frequency of searches for Anosmia, Dysgeusia, and Ageusia, in arbitrary units that are normalized against overall search patterns within each region.
    -->
    The average relative frequency of searches for Anosmia, Dysgeusia, and Ageusia, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s05)
  Description:
    The average relative frequency of searches for Anosmia, Dysgeusia, and Ageusia, in arbitrary units that are normalized against overall search patterns within each region.The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
    -->
    The average relative frequency of searches for Anosmia, Dysgeusia, and Ageusia, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s05)The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
  Name:
    Searches for: Anosmia, Dysgeusia, Ageusia
    -->
    Searches for: Anosmia, Dysgeusia, Ageusia (s05)

MISMATCH!!  [ google-symptoms : s05_smoothed_search ]  dev row: 362 / new row: 364
  Name:
    Searches for: Anosmia, Dysgeusia, Ageusia (7-day average)
    -->
    Searches for: Anosmia, Dysgeusia, Ageusia (s05) (7-day average)

MISMATCH!!  [ google-symptoms : s06_raw_search ]  dev row: 363 / new row: 365
  Short Description:
    The average relative frequency of searches for Laryngitis, Sore throat, and Throat irritation, in arbitrary units that are normalized against overall search patterns within each region.
    -->
    The average relative frequency of searches for Laryngitis, Sore throat, and Throat irritation, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s06)
  Description:
    The average relative frequency of searches for Laryngitis, Sore throat, and Throat irritation, in arbitrary units that are normalized against overall search patterns within each region.The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
    -->
    The average relative frequency of searches for Laryngitis, Sore throat, and Throat irritation, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s06)The symptoms in this set showed positive correlation with cases, especially after Omicron was declared a variant of concern by the WHO.
  Name:
    Searches for: Laryngitis, Sore throat, Throat irritation
    -->
    Searches for: Laryngitis, Sore throat, Throat irritation (s06)

MISMATCH!!  [ google-symptoms : s06_smoothed_search ]  dev row: 364 / new row: 366
  Name:
    Searches for: Laryngitis, Sore throat, Throat irritation (7-day average)
    -->
    Searches for: Laryngitis, Sore throat, Throat irritation (s06) (7-day average)

MISMATCH!!  [ google-symptoms : sum_anosmia_ageusia_raw_search ]  dev row: 367 / new row: 353
  Link:
    https://cmu-delphi.github.io/delphi-epidata/api/covidcast-signals/google-symptoms.html
    -->
    https://cmu-delphi.github.io/delphi-epidata/api/covidcast-signals/google-symptoms.html 
  Description:
    
    -->
    The sum of Google search volume for anosmia and ageusia related searches, in arbitrary units that are normalized for overall search users

MISMATCH!!  [ google-symptoms : s07_raw_search ]  dev row: 369 / new row: 367
  Short Description:
    
    -->
    The average relative frequency of searches for Conjunctivitis, Red eye, Epiphora, Eye pain, Rheum, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s07)
  Link:
    
    -->
    https://cmu-delphi.github.io/delphi-epidata/api/covidcast-signals/google-symptoms.html 
  Description:
    
    -->
    The average relative frequency of searches for Conjunctivitis, Red eye, Epiphora, Eye pain, Rheum, in arbitrary units that are normalized against overall search patterns within each region. (Symptom set s07)
  Name:
    Searches for: Conjunctivitis, Red eye, Epiphora, Eye pain, Rheum
    -->
    Searches for: Conjunctivitis, Red eye, Epiphora, Eye pain, Rheum (s07)

MISMATCH!!  [ google-symptoms : s07_smoothed_search ]  dev row: 370 / new row: 368
  Name:
    Searches for: Conjunctivitis, Red eye, Epiphora, Eye pain, Rheum
    -->
    Searches for: Conjunctivitis, Red eye, Epiphora, Eye pain, Rheum (s07) (smoothed)

MISMATCH!!  [ nhsn : confirmed_admissions_covid_ew ]  dev row: 476 / new row: 476
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of patients hospitalized with confirmed COVID-19 over the epi-week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
    -->
    Total number of patients hospitalized with confirmed COVID-19 over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.

MISMATCH!!  [ nhsn : hosprep_confirmed_admissions_covid_ew ]  dev row: 477 / new row: 477
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of hospitals reporting new admissions with confirmed COVID-19 over the epi-week week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
    -->
    Total number of hospitals reporting new admissions with confirmed COVID-19 over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.

MISMATCH!!  [ nhsn : confirmed_admissions_covid_ew_prelim ]  dev row: 478 / new row: 478
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of patients hospitalized with confirmed COVID-19 over the epi-week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
    -->
    Total number of patients hospitalized with confirmed COVID-19 over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.

MISMATCH!!  [ nhsn : hosprep_confirmed_admissions_covid_ew_prelim ]  dev row: 479 / new row: 479
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of hospitals reporting new admissions with confirmed COVID-19 over the epi-week week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
    -->
    Total number of hospitals reporting new admissions with confirmed COVID-19 over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.

MISMATCH!!  [ nhsn : confirmed_admissions_flu_ew ]  dev row: 480 / new row: 480
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of patients hospitalized with confirmed influenza over the epi-week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
    -->
    Total number of patients hospitalized with confirmed influenza over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.

MISMATCH!!  [ nhsn : hosprep_confirmed_admissions_flu_ew ]  dev row: 481 / new row: 481
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of hospitals reporting new admissions with confirmed flu over the epi-week week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
    -->
    Total number of hospitals reporting new admissions with confirmed flu over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.

MISMATCH!!  [ nhsn : confirmed_admissions_flu_ew_prelim ]  dev row: 482 / new row: 482
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of patients hospitalized with confirmed influenza over the epi-week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
    -->
    Total number of patients hospitalized with confirmed influenza over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.

MISMATCH!!  [ nhsn : hosprep_confirmed_admissions_flu_ew_prelim ]  dev row: 483 / new row: 483
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of hospitals reporting new admissions with confirmed flu over the epi-week week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
    -->
    Total number of hospitals reporting new admissions with confirmed flu over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.

MISMATCH!!  [ nhsn : confirmed_admissions_rsv_ew ]  dev row: 484 / new row: 484
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of patients hospitalized with confirmed RSV-19 over the epi-week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
    -->
    Total number of patients hospitalized with confirmed RSV-19 over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.

MISMATCH!!  [ nhsn : hosprep_confirmed_admissions_rsv_ew ]  dev row: 485 / new row: 485
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of hospitals reporting new admissions with confirmed RSV over the epi-week week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
    -->
    Total number of hospitals reporting new admissions with confirmed RSV over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.

MISMATCH!!  [ nhsn : confirmed_admissions_rsv_ew_prelim ]  dev row: 486 / new row: 486
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of patients hospitalized with confirmed RSV over the epi-week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
    -->
    Total number of patients hospitalized with confirmed RSV over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.

MISMATCH!!  [ nhsn : hosprep_confirmed_admissions_rsv_ew_prelim ]  dev row: 487 / new row: 487
  Value Label:
    
    -->
    Value
  Category:
    
    -->
    late
  High Values Are:
    
    -->
    bad
  Description:
    Total number of hospitals reporting new admissions with confirmed RSV over the epi-week week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
    -->
    Total number of hospitals reporting new admissions with confirmed RSV over the epiweek (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.


lines with changes: 31

@melange396
Copy link
Collaborator

@carlynvandyke does that look right? ^
Note that it isnt showing any changes made in the renamed columns, but i can do that if you think it might be important or helpful/useful.

I did a very exhaustive search through the code for the api server and the covidcast dashboard, and i think all of those column renamings are safe -- none of the old names seem to be used directly. One of the new names might be a little problematic, though it shouldnt "break" anything... However, it could be very confusing in that "Data Source" will become "data_source" in the meta endpoint respose, and that is a keyword used throughout the API to refer to the "source" name (having values like chng, google-symptoms, fb-survey, etc). Could we call that something else?

"data_source": data_source,

@melange396
Copy link
Collaborator

In a side channel, @carlynvandyke and i had a short discussion about what the "Data Source" column. It was called "Source Name" before this, and she has since changed it back to that. We may end up renaming it again at some point, as it is intended to be referred to as "Original Data Provider" in the discovery app.

@melange396
Copy link
Collaborator

We can remove the "Source Name" column from the indicators sheet/tab/table, per @dmytrotsko, as it can be retrieved by cross-referencing with the "Data Source" sheet/tab/table. Im gonna merge this PR and we can do that in the next one.

@melange396 melange396 merged commit 2811f57 into dev Apr 1, 2025
7 checks passed
@melange396 melange396 deleted the bot/update-docs branch April 1, 2025 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant