From e542e753bd3662adb4bb48ed17355a5ac19d5689 Mon Sep 17 00:00:00 2001 From: Nat DeFries <42820733+nmdefries@users.noreply.github.com> Date: Thu, 29 Aug 2024 15:58:17 -0400 Subject: [PATCH 1/9] mark ght as inactive, and change nav --- docs/api/covidcast-signals/ght.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/covidcast-signals/ght.md b/docs/api/covidcast-signals/ght.md index d479b9932..9b592f60e 100644 --- a/docs/api/covidcast-signals/ght.md +++ b/docs/api/covidcast-signals/ght.md @@ -1,8 +1,8 @@ --- -title: Google Health Trends -parent: Inactive Signals -nav_order: 2 +title: inactive Google Health Trends +parent: Data Sources and Signals grand_parent: Main Endpoint (COVIDcast) +nav_order: 2 --- # Google Health Trends From a20d62373ebd6b289ac08b2c608440c50092b96e Mon Sep 17 00:00:00 2001 From: Nat DeFries <42820733+nmdefries@users.noreply.github.com> Date: Thu, 29 Aug 2024 15:58:47 -0400 Subject: [PATCH 2/9] group parent and grandparent vars in frontmatter --- docs/api/covidcast-signals/covid-act-now.md | 2 +- docs/api/covidcast-signals/dsew-cpr.md | 2 +- docs/api/covidcast-signals/google-symptoms.md | 4 ++-- docs/api/covidcast-signals/hhs.md | 2 +- docs/api/covidcast-signals/jhu-csse.md | 2 +- docs/api/covidcast-signals/safegraph.md | 2 +- docs/api/covidcast-signals/usa-facts.md | 2 +- docs/api/covidcast-signals/youtube-survey.md | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/api/covidcast-signals/covid-act-now.md b/docs/api/covidcast-signals/covid-act-now.md index 204f14685..41a5cabc2 100644 --- a/docs/api/covidcast-signals/covid-act-now.md +++ b/docs/api/covidcast-signals/covid-act-now.md @@ -1,8 +1,8 @@ --- title: inactive COVID Act Now parent: Data Sources and Signals -nav_order: 2 grand_parent: Main Endpoint (COVIDcast) +nav_order: 2 --- # COVID Act Now (CAN) diff --git a/docs/api/covidcast-signals/dsew-cpr.md b/docs/api/covidcast-signals/dsew-cpr.md index 9a0050924..63240e3f2 100644 --- a/docs/api/covidcast-signals/dsew-cpr.md +++ b/docs/api/covidcast-signals/dsew-cpr.md @@ -1,8 +1,8 @@ --- title: inactive Data Strategy and Execution Workgroup Community Profile Report parent: Data Sources and Signals -nav_order: 2 grand_parent: Main Endpoint (COVIDcast) +nav_order: 2 --- # Data Strategy and Execution Workgroup Community Profile Report (CPR) diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index 4b7d00efd..f856920f3 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -1,8 +1,8 @@ --- -title: Google Search Trends Symptoms +title: Google Symptom Search Trends parent: Data Sources and Signals -nav_order: 1 grand_parent: Main Endpoint (COVIDcast) +nav_order: 1 --- # Google Symptoms diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index 7dd2d9d04..c678acdf3 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -1,8 +1,8 @@ --- title: inactive Department of Health & Human Services parent: Data Sources and Signals -nav_order: 2 grand_parent: Main Endpoint (COVIDcast) +nav_order: 2 --- # Department of Health & Human Services diff --git a/docs/api/covidcast-signals/jhu-csse.md b/docs/api/covidcast-signals/jhu-csse.md index 03e0544bd..c9d665b5a 100644 --- a/docs/api/covidcast-signals/jhu-csse.md +++ b/docs/api/covidcast-signals/jhu-csse.md @@ -1,8 +1,8 @@ --- title: inactive JHU Cases and Deaths parent: Data Sources and Signals -nav_order: 2 grand_parent: Main Endpoint (COVIDcast) +nav_order: 2 --- # JHU Cases and Deaths diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index 776dd98ed..8824c3e3e 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -1,8 +1,8 @@ --- title: inactive SafeGraph parent: Data Sources and Signals -nav_order: 2 grand_parent: Main Endpoint (COVIDcast) +nav_order: 2 --- # SafeGraph diff --git a/docs/api/covidcast-signals/usa-facts.md b/docs/api/covidcast-signals/usa-facts.md index 5fc67ec1f..fe08dc911 100644 --- a/docs/api/covidcast-signals/usa-facts.md +++ b/docs/api/covidcast-signals/usa-facts.md @@ -1,8 +1,8 @@ --- title: inactive USAFacts Cases and Deaths parent: Data Sources and Signals -nav_order: 2 grand_parent: Main Endpoint (COVIDcast) +nav_order: 2 --- # USAFacts Cases and Deaths diff --git a/docs/api/covidcast-signals/youtube-survey.md b/docs/api/covidcast-signals/youtube-survey.md index dcbc7b879..62b7542bf 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -1,8 +1,8 @@ --- title: inactive Youtube Survey parent: Data Sources and Signals -nav_order: 2 grand_parent: Main Endpoint (COVIDcast) +nav_order: 2 --- [//]: # (code at https://github.com/cmu-delphi/covid-19/tree/deeb4dc1e9a30622b415361ef6b99198e77d2a94/youtube) From 3c068edbfcf65325c2e3dca1e6101077183a02bf Mon Sep 17 00:00:00 2001 From: Nat DeFries <42820733+nmdefries@users.noreply.github.com> Date: Tue, 3 Sep 2024 15:41:43 -0400 Subject: [PATCH 3/9] fb survey title --- docs/api/covidcast-signals/fb-survey.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/fb-survey.md b/docs/api/covidcast-signals/fb-survey.md index 6b798ec7a..f3ecd4515 100644 --- a/docs/api/covidcast-signals/fb-survey.md +++ b/docs/api/covidcast-signals/fb-survey.md @@ -5,7 +5,7 @@ grand_parent: Main Endpoint (COVIDcast) nav_order: 2 --- -# COVID-19 Trends and Impact Survey 2020-2022 (Facebook Survey) +# COVID-19 Trends and Impact Survey (CTIS) {: .no_toc} * **Source name:** `fb-survey` @@ -28,6 +28,8 @@ shared back to Facebook. See our [surveys page](https://delphi.cmu.edu/covid19/ctis/) for more detail about how the surveys work and how they are used outside the COVIDcast API. +This survey was also known unofficially as the Facebook Survey. + As of November 2021, the average number of Facebook survey responses we received each day was about 40,000. The survey ran from April 6, 2020 to June 25, 2022, collecting roughly 29.5 million responses in the United States in that From 9d45ed822caf216bd647e53d4edd0f6acd429b47 Mon Sep 17 00:00:00 2001 From: Nat DeFries <42820733+nmdefries@users.noreply.github.com> Date: Tue, 3 Sep 2024 16:01:37 -0400 Subject: [PATCH 4/9] rename fb-survey doc and provide permalink to display in proper alphabetical order --- .../{fb-survey.md => covid-trends-and-impact-survey.md} | 1 + 1 file changed, 1 insertion(+) rename docs/api/covidcast-signals/{fb-survey.md => covid-trends-and-impact-survey.md} (99%) diff --git a/docs/api/covidcast-signals/fb-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md similarity index 99% rename from docs/api/covidcast-signals/fb-survey.md rename to docs/api/covidcast-signals/covid-trends-and-impact-survey.md index f3ecd4515..147566f98 100644 --- a/docs/api/covidcast-signals/fb-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -3,6 +3,7 @@ title: inactive COVID-19 Trends and Impact Survey parent: Data Sources and Signals grand_parent: Main Endpoint (COVIDcast) nav_order: 2 +permalink: api/covidcast-signals/fb-survey.html --- # COVID-19 Trends and Impact Survey (CTIS) From 5f32e980ce41e5d33a858aa989fef44c4b879ad1 Mon Sep 17 00:00:00 2001 From: Nat DeFries <42820733+nmdefries@users.noreply.github.com> Date: Tue, 3 Sep 2024 16:02:00 -0400 Subject: [PATCH 5/9] rename hhs page for alphabetization; mention NHSN for searchability --- docs/api/covidcast-signals/hhs.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index c678acdf3..71919695a 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -1,11 +1,11 @@ --- -title: inactive Department of Health & Human Services +title: inactive HHS Hospitalizations parent: Data Sources and Signals grand_parent: Main Endpoint (COVIDcast) nav_order: 2 --- -# Department of Health & Human Services +# Department of Health & Human Services Hospitalizations {: .no_toc} * **Source name:** `hhs` @@ -17,7 +17,8 @@ nav_order: 2 * **License:** [Public Domain US Government](https://www.usa.gov/government-works) The U.S. Department of Health & Human Services (HHS) publishes several -datasets on patient impact and hospital capacity. One of these +datasets on patient impact and hospital capacity. The data is made available +to HHS through the CDC’s National Healthcare Safety Network (NHSN). One of these datasets is mirrored in Epidata at the following endpoint: * [COVID-19 Hospitalization: States](../covid_hosp.md) - daily resolution, state aggregates From f6d552a5d1973ab13a9666cee972ea23b58c8c6c Mon Sep 17 00:00:00 2001 From: Nat DeFries <42820733+nmdefries@users.noreply.github.com> Date: Tue, 3 Sep 2024 16:25:49 -0400 Subject: [PATCH 6/9] alphabetize data sources by changing file names; set permalinks so urls don't change --- docs/api/{meta.md => 01meta.md} | 5 +++-- .../{dengue_sensors.md => dengue_digital_surveillance.md} | 1 + docs/api/{sensors.md => digital_surveillance_sensors.md} | 1 + docs/api/{nowcast.md => ili_nearby_nowcast.md} | 1 + docs/api/{meta_norostat.md => norostat_meta.md} | 1 + 5 files changed, 7 insertions(+), 2 deletions(-) rename docs/api/{meta.md => 01meta.md} (96%) rename docs/api/{dengue_sensors.md => dengue_digital_surveillance.md} (97%) rename docs/api/{sensors.md => digital_surveillance_sensors.md} (99%) rename docs/api/{nowcast.md => ili_nearby_nowcast.md} (99%) rename docs/api/{meta_norostat.md => norostat_meta.md} (97%) diff --git a/docs/api/meta.md b/docs/api/01meta.md similarity index 96% rename from docs/api/meta.md rename to docs/api/01meta.md index 752e85fcb..803a0a9e1 100644 --- a/docs/api/meta.md +++ b/docs/api/01meta.md @@ -1,11 +1,12 @@ --- -title: inactive Metadata +title: inactive Epidata Metadata parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) nav_order: 2 +permalink: api/meta.html --- -# API Metadata +# Epidata Metadata This is the documentation of the API for accessing the API Metadata (`meta`) for `fluview`, `twitter`, `wiki`, and `delphi` endpoints of the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. diff --git a/docs/api/dengue_sensors.md b/docs/api/dengue_digital_surveillance.md similarity index 97% rename from docs/api/dengue_sensors.md rename to docs/api/dengue_digital_surveillance.md index 7c86a1688..9351e7dff 100644 --- a/docs/api/dengue_sensors.md +++ b/docs/api/dengue_digital_surveillance.md @@ -3,6 +3,7 @@ title: inactive Dengue Digital Surveillance parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) nav_order: 2 +permalink: api/dengue_sensors.html --- # Dengue Digital Surveillance Sensors diff --git a/docs/api/sensors.md b/docs/api/digital_surveillance_sensors.md similarity index 99% rename from docs/api/sensors.md rename to docs/api/digital_surveillance_sensors.md index 0a2238ca5..6437d58a3 100644 --- a/docs/api/sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -3,6 +3,7 @@ title: inactive Digital Surveillance Sensors parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) nav_order: 2 +permalink: api/sensors.html --- # Digital Surveillance Sensors diff --git a/docs/api/nowcast.md b/docs/api/ili_nearby_nowcast.md similarity index 99% rename from docs/api/nowcast.md rename to docs/api/ili_nearby_nowcast.md index aa82077a0..defd13b22 100644 --- a/docs/api/nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -3,6 +3,7 @@ title: inactive ILI Nearby Nowcast parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) nav_order: 2 +permalink: api/nowcast.html --- # ILI Nearby Nowcast diff --git a/docs/api/meta_norostat.md b/docs/api/norostat_meta.md similarity index 97% rename from docs/api/meta_norostat.md rename to docs/api/norostat_meta.md index 1f2754eea..47b99dfd0 100644 --- a/docs/api/meta_norostat.md +++ b/docs/api/norostat_meta.md @@ -3,6 +3,7 @@ title: inactive NoroSTAT Metadata parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) nav_order: 2 +permalink: api/meta_norostat.html --- # NoroSTAT Metadata From 3160e750338e16aa005290da62d52db857058344 Mon Sep 17 00:00:00 2001 From: Nat DeFries <42820733+nmdefries@users.noreply.github.com> Date: Tue, 3 Sep 2024 16:26:01 -0400 Subject: [PATCH 7/9] capitalize title --- docs/api/fluview_meta.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/fluview_meta.md b/docs/api/fluview_meta.md index e12d1f25d..0826a98ba 100644 --- a/docs/api/fluview_meta.md +++ b/docs/api/fluview_meta.md @@ -1,11 +1,11 @@ --- -title: FluView metadata +title: FluView Metadata parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) nav_order: 1 --- -# FluView metadata +# FluView Metadata This is the API documentation for accessing the FluView metadata (`fluview_meta`) endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological From aa1861a1466ce90234ef5177fa1b767657d8d5ef Mon Sep 17 00:00:00 2001 From: Nat DeFries <42820733+nmdefries@users.noreply.github.com> Date: Tue, 3 Sep 2024 17:47:55 -0400 Subject: [PATCH 8/9] add NHSN to HHS title --- docs/api/covidcast-signals/hhs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index 71919695a..8c8f096fd 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -1,5 +1,5 @@ --- -title: inactive HHS Hospitalizations +title: inactive HHS/NHSN Hospitalizations parent: Data Sources and Signals grand_parent: Main Endpoint (COVIDcast) nav_order: 2 From f4848c7ac9cf6e8be8a5af4b9dbd28decb2ef5c2 Mon Sep 17 00:00:00 2001 From: nmdefries <42820733+nmdefries@users.noreply.github.com> Date: Thu, 13 Feb 2025 13:33:49 -0500 Subject: [PATCH 9/9] new hhs title for clarity --- docs/api/covidcast-signals/hhs.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index 8c8f096fd..de78eecf7 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -1,5 +1,5 @@ --- -title: inactive HHS/NHSN Hospitalizations +title: inactive HHS Hospitalizations from NHSN parent: Data Sources and Signals grand_parent: Main Endpoint (COVIDcast) nav_order: 2 @@ -29,7 +29,7 @@ resource usage in different ways. This indicator makes available several commonly-used columns and combinations of columns, aggregated geographically. In particular, we include the sum of all adult and pediatric COVID-19 hospital admissions. This sum is used as the -"ground truth" for hospitalizations by the +"ground truth" for hospitalizations by the [COVID-19 Forecast Hub](https://github.com/reichlab/covid19-forecast-hub/blob/master/data-processed/README.md#hospitalizations). We also include influenza hospital admissions. @@ -117,6 +117,6 @@ is first published. ## Source and Licensing This indicator mirrors and lightly aggregates data originally -published by the U.S. Department of Health & Human Services. -As a work of the US government, the original data is in the +published by the U.S. Department of Health & Human Services. +As a work of the US government, the original data is in the [public domain](https://www.usa.gov/government-works).