From f7fbf218e9ebc33c5c28fae5e01e4527a368b204 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 14:22:56 -0700 Subject: [PATCH 01/64] doc: clarify data revisions field, link to changelog, make it consistent --- docs/api/covidcast-signals/_source-template.md | 4 ++-- docs/api/covidcast-signals/chng.md | 4 ++-- docs/api/covidcast-signals/covid-act-now.md | 4 ++-- .../covid-trends-and-impact-survey.md | 4 ++-- docs/api/covidcast-signals/doctor-visits.md | 4 ++-- docs/api/covidcast-signals/dsew-cpr.md | 4 ++-- docs/api/covidcast-signals/ght.md | 4 ++-- docs/api/covidcast-signals/google-survey.md | 4 ++-- docs/api/covidcast-signals/google-symptoms.md | 4 ++-- docs/api/covidcast-signals/hhs.md | 4 ++-- docs/api/covidcast-signals/hospital-admissions.md | 4 ++-- docs/api/covidcast-signals/indicator-combination.md | 10 +++++----- docs/api/covidcast-signals/jhu-csse.md | 4 ++-- docs/api/covidcast-signals/nchs-mortality.md | 4 ++-- docs/api/covidcast-signals/nhsn.md | 4 ++-- docs/api/covidcast-signals/nssp.md | 4 ++-- docs/api/covidcast-signals/quidel.md | 8 ++++---- docs/api/covidcast-signals/safegraph.md | 8 ++++---- docs/api/covidcast-signals/usa-facts.md | 4 ++-- docs/api/covidcast-signals/youtube-survey.md | 4 ++-- 20 files changed, 47 insertions(+), 47 deletions(-) diff --git a/docs/api/covidcast-signals/_source-template.md b/docs/api/covidcast-signals/_source-template.md index f2e966817..c6ccb983a 100644 --- a/docs/api/covidcast-signals/_source-template.md +++ b/docs/api/covidcast-signals/_source-template.md @@ -9,8 +9,8 @@ grand_parent: Main Endpoint (COVIDcast) * **Source name:** `SOURCE-API-NAME` * **Earliest issue available:** DATE RELEASED TO API -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [LICENSE NAME](../covidcast_licensing.md#APPLICABLE-SECTION) diff --git a/docs/api/covidcast-signals/chng.md b/docs/api/covidcast-signals/chng.md index 06b6d5a29..04d2de870 100644 --- a/docs/api/covidcast-signals/chng.md +++ b/docs/api/covidcast-signals/chng.md @@ -10,8 +10,8 @@ nav_order: 1 * **Source name:** `chng` * **Earliest issue available:** November 4, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#chng)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#chng)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) diff --git a/docs/api/covidcast-signals/covid-act-now.md b/docs/api/covidcast-signals/covid-act-now.md index 41a5cabc2..7a7ace82b 100644 --- a/docs/api/covidcast-signals/covid-act-now.md +++ b/docs/api/covidcast-signals/covid-act-now.md @@ -10,8 +10,8 @@ nav_order: 2 * **Source name:** `covid-act-now` * **Earliest issue available:** 2021-03-25 -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#covid-act-now)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#covid-act-now)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) diff --git a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md index 147566f98..23fe30722 100644 --- a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -11,8 +11,8 @@ permalink: api/covidcast-signals/fb-survey.html * **Source name:** `fb-survey` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** [June 3, 2020](../covidcast_changelog.md#fb-survey) +* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#fb-survey)) +* **Date of last data revision:** June 3, 2020 (see [data revision docs](../covidcast_changelog.md#fb-survey)) * **Available for:** county, hrr, msa, state, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) diff --git a/docs/api/covidcast-signals/doctor-visits.md b/docs/api/covidcast-signals/doctor-visits.md index 5eb9c96a9..fc1627143 100644 --- a/docs/api/covidcast-signals/doctor-visits.md +++ b/docs/api/covidcast-signals/doctor-visits.md @@ -10,8 +10,8 @@ nav_order: 1 * **Source name:** `doctor-visits` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** November 9, 2020 +* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) +* **Date of last data revision:** November 9, 2020 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) diff --git a/docs/api/covidcast-signals/dsew-cpr.md b/docs/api/covidcast-signals/dsew-cpr.md index 82e76d7df..9469f50f9 100644 --- a/docs/api/covidcast-signals/dsew-cpr.md +++ b/docs/api/covidcast-signals/dsew-cpr.md @@ -10,8 +10,8 @@ nav_order: 2 * **Source name:** `dsew-cpr` * **Earliest issue available:** 2022-01-28 -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#dsew-cpr)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#dsew-cpr)) * **Available for:** county, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) diff --git a/docs/api/covidcast-signals/ght.md b/docs/api/covidcast-signals/ght.md index 9b592f60e..19f1122ce 100644 --- a/docs/api/covidcast-signals/ght.md +++ b/docs/api/covidcast-signals/ght.md @@ -10,8 +10,8 @@ nav_order: 2 * **Source name:** `ght` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#ght)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#ght)) * **Available for:** dma, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md index d758d6a8b..e50ce6f1b 100644 --- a/docs/api/covidcast-signals/google-survey.md +++ b/docs/api/covidcast-signals/google-survey.md @@ -10,8 +10,8 @@ nav_order: 2 * **Source name:** `google-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#google-survey)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#google-survey)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index f37926242..620edc5df 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -10,8 +10,8 @@ nav_order: 1 * **Source name:** `google-symptoms` * **Earliest issue available:** Aug 20, 2017 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** February 28, 2025 +* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) +* **Date of last data revision:** February 28, 2025 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) * **Available for:** county, MSA, HRR, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** To download or use the data, you must agree to the Google [Terms of Service](https://policies.google.com/terms) diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index d591aa720..2db1279ef 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -10,8 +10,8 @@ nav_order: 2 * **Source name:** `hhs` * **Earliest issue available:** November 16, 2020 -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#hhs)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#hhs)) * **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) diff --git a/docs/api/covidcast-signals/hospital-admissions.md b/docs/api/covidcast-signals/hospital-admissions.md index 1dcd5959f..8acfe5b3d 100644 --- a/docs/api/covidcast-signals/hospital-admissions.md +++ b/docs/api/covidcast-signals/hospital-admissions.md @@ -10,8 +10,8 @@ nav_order: 1 * **Source name:** `hospital-admissions` * **Earliest issue available:** June 21, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** October 20, 2020 +* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#hospital-admissions)) +* **Date of last data revision:** October 20, 2020 (see [data revision docs](../covidcast_changelog.md#hospital-admissions)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index fe2edd3cf..5c7b094ba 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -22,8 +22,8 @@ calculated or composed by Delphi. It is not a primary data source. ## Statistical Combination Signals * **Earliest issue available:** May 20, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** [June 3, 2020](../covidcast_changelog.md#indicator-combination) +* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) +* **Date of last data revision:** June 3, 2020 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) * **Available for:** county, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) @@ -191,9 +191,9 @@ The resampling method for each input source is as follows: ## Compositional Signals: Confirmed Cases and Deaths -* **Earliest issue available:** 7 July 2020 -* **Number of data revisions since 19 May 2020:** 1 -* **Date of last change:** [12 October 2020](../covidcast_changelog.md#indicator-combination) +* **Earliest issue available:** 7 July, 2020 +* **Number of data revisions since 19 May 2020:** 1 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) +* **Date of last data revision:** 12 October, 2020 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) * **Available for:** county, msa, hrr, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/jhu-csse.md b/docs/api/covidcast-signals/jhu-csse.md index c9d665b5a..04ba8c731 100644 --- a/docs/api/covidcast-signals/jhu-csse.md +++ b/docs/api/covidcast-signals/jhu-csse.md @@ -10,8 +10,8 @@ nav_order: 2 * **Source name:** `jhu-csse` * **Earliest issue available:** May 7, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** [October 7, 2020](../covidcast_changelog.md#jhu-csse) +* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) +* **Date of last data revision:** October 7, 2020 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](#source-and-licensing) diff --git a/docs/api/covidcast-signals/nchs-mortality.md b/docs/api/covidcast-signals/nchs-mortality.md index 94a72ead2..3dfde30cb 100644 --- a/docs/api/covidcast-signals/nchs-mortality.md +++ b/docs/api/covidcast-signals/nchs-mortality.md @@ -10,8 +10,8 @@ nav_order: 1 * **Source name:** `nchs-mortality` * **Earliest issue available:** Epiweek 50 2020 (6-12 December 2020) -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#nchs-mortality)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#nchs-mortality)) * **Available for:** state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** week (see [date format docs](../covidcast_times.md)) * **License:** [NCHS Data Use Agreement](https://www.cdc.gov/nchs/data_access/restrictions.htm) diff --git a/docs/api/covidcast-signals/nhsn.md b/docs/api/covidcast-signals/nhsn.md index 2fc89afd7..ef95c2f29 100644 --- a/docs/api/covidcast-signals/nhsn.md +++ b/docs/api/covidcast-signals/nhsn.md @@ -9,8 +9,8 @@ nav_order: 1 * **Source name:** `nhsn` * **Earliest issue available:** November 19, 2024 -* **Number of data revisions since 18 Nov 2024:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#nhsn)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#nhsn)) * **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** week (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) diff --git a/docs/api/covidcast-signals/nssp.md b/docs/api/covidcast-signals/nssp.md index 8e988a25b..27241a4c3 100644 --- a/docs/api/covidcast-signals/nssp.md +++ b/docs/api/covidcast-signals/nssp.md @@ -9,8 +9,8 @@ nav_order: 1 * **Source name:** `nssp` * **Earliest issue available:** April 17, 2024 -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#nssp)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#nssp)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** week (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) diff --git a/docs/api/covidcast-signals/quidel.md b/docs/api/covidcast-signals/quidel.md index 430339291..381ad9cc7 100644 --- a/docs/api/covidcast-signals/quidel.md +++ b/docs/api/covidcast-signals/quidel.md @@ -20,8 +20,8 @@ nav_order: 1 * **Source name:** `quidel` * **Earliest issue available:** July 29, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** October 22, 2020 +* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#quidel)) +* **Date of last data revision:** October 22, 2020 (see [data revision docs](../covidcast_changelog.md#quidel)) * **Available for:** county, hrr, msa, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) @@ -168,8 +168,8 @@ These signals are inactive. They were updated until May 19, 2020. * **Source name:** `quidel` * **Earliest issue available:** April 29, 2020 * **Last issued:** May 19, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#quidel)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#quidel)) * **Available for:** msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index 96775de0f..c4b922e15 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -26,8 +26,8 @@ surface signals from two such datasets. ## SafeGraph Social Distancing Metrics * **Earliest issue available:** June 20, 2020 -* **Number of data revisions since June 23, 2020:** 1 -* **Date of last change:** November 3, 2020 +* **Number of data revisions since 23 June, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#safegraph)) +* **Date of last data revision:** November 3, 2020 (see [data revision docs](../covidcast_changelog.md#safegraph)) **This dataset is no longer updated after April 19th, 2021.** @@ -77,8 +77,8 @@ additional day for SafeGraph's data to be ingested into the COVIDcast API. ## SafeGraph Weekly Patterns * **Earliest issue available:** November 30, 2020 -* **Number of data revisions since June 23, 2020:** 0 -* **Date of last change:** never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#safegraph)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#safegraph)) **This dataset is no longer updated after July 15th, 2022.** diff --git a/docs/api/covidcast-signals/usa-facts.md b/docs/api/covidcast-signals/usa-facts.md index 3c972cfcd..722032a14 100644 --- a/docs/api/covidcast-signals/usa-facts.md +++ b/docs/api/covidcast-signals/usa-facts.md @@ -10,8 +10,8 @@ nav_order: 2 * **Source name:** `usa-facts` * **Earliest issue available:** June 24, 2020 -* **Number of data revisions since May 19, 2020:** 2 -* **Date of last change:** [November 3, 2020](../covidcast_changelog.md#usa-facts) +* **Number of data revisions since 19 May, 2020:** 2 (see [data revision docs](../covidcast_changelog.md#usa-facts)) +* **Date of last data revision:** November 3, 2020 (see [data revision docs](../covidcast_changelog.md#usa-facts)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](#source-and-licensing) diff --git a/docs/api/covidcast-signals/youtube-survey.md b/docs/api/covidcast-signals/youtube-survey.md index 5b376f913..4d9f395f1 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -12,8 +12,8 @@ nav_order: 2 * **Source name:** `youtube-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never +* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#youtube-survey)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#youtube-survey)) * **Available for:** state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) From 3c3030c7f55102d9b05843e714eda01a1a732e5e Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 15:16:03 -0700 Subject: [PATCH 02/64] Update docs/api/covidcast-signals/covid-trends-and-impact-survey.md Co-authored-by: george --- docs/api/covidcast-signals/covid-trends-and-impact-survey.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md index 23fe30722..b9ddf7621 100644 --- a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -11,7 +11,7 @@ permalink: api/covidcast-signals/fb-survey.html * **Source name:** `fb-survey` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#fb-survey)) +* **Number of data revisions since May 19, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#fb-survey)) * **Date of last data revision:** June 3, 2020 (see [data revision docs](../covidcast_changelog.md#fb-survey)) * **Available for:** county, hrr, msa, state, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From 763501139340888c56d00714f36fde2b311a0b57 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:10:27 -0700 Subject: [PATCH 03/64] Update docs/api/covidcast-signals/_source-template.md Co-authored-by: george --- docs/api/covidcast-signals/_source-template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/covidcast-signals/_source-template.md b/docs/api/covidcast-signals/_source-template.md index c6ccb983a..0dcccff6e 100644 --- a/docs/api/covidcast-signals/_source-template.md +++ b/docs/api/covidcast-signals/_source-template.md @@ -9,8 +9,8 @@ grand_parent: Main Endpoint (COVIDcast) * **Source name:** `SOURCE-API-NAME` * **Earliest issue available:** DATE RELEASED TO API -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#template)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#template)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [LICENSE NAME](../covidcast_licensing.md#APPLICABLE-SECTION) From f9b1906da1195cf2ec54162acc03b73d9f40544a Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:10:40 -0700 Subject: [PATCH 04/64] Update docs/api/covidcast-signals/chng.md Co-authored-by: george --- docs/api/covidcast-signals/chng.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/chng.md b/docs/api/covidcast-signals/chng.md index 04d2de870..95441c98c 100644 --- a/docs/api/covidcast-signals/chng.md +++ b/docs/api/covidcast-signals/chng.md @@ -10,7 +10,7 @@ nav_order: 1 * **Source name:** `chng` * **Earliest issue available:** November 4, 2020 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#chng)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#chng)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#chng)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From a89d638a58cc5b1d5fcfee4c3fb0f7454808e36f Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:10:46 -0700 Subject: [PATCH 05/64] Update docs/api/covidcast-signals/covid-act-now.md Co-authored-by: george --- docs/api/covidcast-signals/covid-act-now.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/covid-act-now.md b/docs/api/covidcast-signals/covid-act-now.md index 7a7ace82b..9486d47dc 100644 --- a/docs/api/covidcast-signals/covid-act-now.md +++ b/docs/api/covidcast-signals/covid-act-now.md @@ -9,7 +9,7 @@ nav_order: 2 {: .no_toc} * **Source name:** `covid-act-now` -* **Earliest issue available:** 2021-03-25 +* **Earliest issue available:** March 25, 2021 * **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#covid-act-now)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#covid-act-now)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) From 45067676a528436f6c96bc64a13feedeb81669f1 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:11:02 -0700 Subject: [PATCH 06/64] Update docs/api/covidcast-signals/covid-act-now.md Co-authored-by: george --- docs/api/covidcast-signals/covid-act-now.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/covid-act-now.md b/docs/api/covidcast-signals/covid-act-now.md index 9486d47dc..ec0f6bd37 100644 --- a/docs/api/covidcast-signals/covid-act-now.md +++ b/docs/api/covidcast-signals/covid-act-now.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `covid-act-now` * **Earliest issue available:** March 25, 2021 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#covid-act-now)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#covid-act-now)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#covid-act-now)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From 6a6a240235f94df6c6c9464d3a676b9e8f16ca19 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:11:14 -0700 Subject: [PATCH 07/64] Update docs/api/covidcast-signals/doctor-visits.md Co-authored-by: george --- docs/api/covidcast-signals/doctor-visits.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/doctor-visits.md b/docs/api/covidcast-signals/doctor-visits.md index fc1627143..e1eb40391 100644 --- a/docs/api/covidcast-signals/doctor-visits.md +++ b/docs/api/covidcast-signals/doctor-visits.md @@ -10,7 +10,7 @@ nav_order: 1 * **Source name:** `doctor-visits` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) +* **Number of data revisions since May 19, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) * **Date of last data revision:** November 9, 2020 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From e254c1a84b266285322454db5b744931931c1ebf Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:11:25 -0700 Subject: [PATCH 08/64] Update docs/api/covidcast-signals/dsew-cpr.md Co-authored-by: george --- docs/api/covidcast-signals/dsew-cpr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/dsew-cpr.md b/docs/api/covidcast-signals/dsew-cpr.md index 9469f50f9..0b1f1bdf6 100644 --- a/docs/api/covidcast-signals/dsew-cpr.md +++ b/docs/api/covidcast-signals/dsew-cpr.md @@ -9,7 +9,7 @@ nav_order: 2 {: .no_toc} * **Source name:** `dsew-cpr` -* **Earliest issue available:** 2022-01-28 +* **Earliest issue available:** January 28, 2022 * **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#dsew-cpr)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#dsew-cpr)) * **Available for:** county, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) From 884c73a2b3d35bee307f22cbb66f1a156afaa9f2 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:12:39 -0700 Subject: [PATCH 09/64] Update docs/api/covidcast-signals/dsew-cpr.md Co-authored-by: george --- docs/api/covidcast-signals/dsew-cpr.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/dsew-cpr.md b/docs/api/covidcast-signals/dsew-cpr.md index 0b1f1bdf6..1898d1760 100644 --- a/docs/api/covidcast-signals/dsew-cpr.md +++ b/docs/api/covidcast-signals/dsew-cpr.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `dsew-cpr` * **Earliest issue available:** January 28, 2022 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#dsew-cpr)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#dsew-cpr)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#dsew-cpr)) * **Available for:** county, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From e84b3dfbb621573828a785ad601fc53a2f7fe70e Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:12:44 -0700 Subject: [PATCH 10/64] Update docs/api/covidcast-signals/safegraph.md Co-authored-by: george --- docs/api/covidcast-signals/safegraph.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index c4b922e15..3202d90b9 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -77,7 +77,7 @@ additional day for SafeGraph's data to be ingested into the COVIDcast API. ## SafeGraph Weekly Patterns * **Earliest issue available:** November 30, 2020 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#safegraph)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#safegraph)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#safegraph)) **This dataset is no longer updated after July 15th, 2022.** From d8ddcf6c0de560509f600590dab99859cc68244b Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:13:28 -0700 Subject: [PATCH 11/64] Update docs/api/covidcast-signals/ght.md Co-authored-by: george --- docs/api/covidcast-signals/ght.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/ght.md b/docs/api/covidcast-signals/ght.md index 19f1122ce..6839dd44f 100644 --- a/docs/api/covidcast-signals/ght.md +++ b/docs/api/covidcast-signals/ght.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `ght` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#ght)) +* **Number of data revisions since May 19, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#ght)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#ght)) * **Available for:** dma, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From 33d03a6007390b03edcd1284e4185855024507cf Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:13:36 -0700 Subject: [PATCH 12/64] Update docs/api/covidcast-signals/google-survey.md Co-authored-by: george --- docs/api/covidcast-signals/google-survey.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md index e50ce6f1b..9857c9249 100644 --- a/docs/api/covidcast-signals/google-survey.md +++ b/docs/api/covidcast-signals/google-survey.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `google-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#google-survey)) +* **Number of data revisions since May 19, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#google-survey)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#google-survey)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From 078d38a7c1fd9266978ea5af944a67d3a4dc0bfb Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:13:45 -0700 Subject: [PATCH 13/64] Update docs/api/covidcast-signals/google-symptoms.md Co-authored-by: george --- docs/api/covidcast-signals/google-symptoms.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index 620edc5df..2f979c70d 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -10,7 +10,7 @@ nav_order: 1 * **Source name:** `google-symptoms` * **Earliest issue available:** Aug 20, 2017 -* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) +* **Number of data revisions since May 19, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) * **Date of last data revision:** February 28, 2025 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) * **Available for:** county, MSA, HRR, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From c4084bbd8b749a0ea8f5d9a133385810605edc19 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:13:53 -0700 Subject: [PATCH 14/64] Update docs/api/covidcast-signals/hhs.md Co-authored-by: george --- 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 2db1279ef..e39dfd4f7 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `hhs` * **Earliest issue available:** November 16, 2020 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#hhs)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#hhs)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#hhs)) * **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From e779c209d5c323d6b8e63ab1a3112257370e3966 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:14:02 -0700 Subject: [PATCH 15/64] Update docs/api/covidcast-signals/hospital-admissions.md Co-authored-by: george --- docs/api/covidcast-signals/hospital-admissions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/hospital-admissions.md b/docs/api/covidcast-signals/hospital-admissions.md index 8acfe5b3d..152249a44 100644 --- a/docs/api/covidcast-signals/hospital-admissions.md +++ b/docs/api/covidcast-signals/hospital-admissions.md @@ -10,7 +10,7 @@ nav_order: 1 * **Source name:** `hospital-admissions` * **Earliest issue available:** June 21, 2020 -* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#hospital-admissions)) +* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#hospital-admissions)) * **Date of last data revision:** October 20, 2020 (see [data revision docs](../covidcast_changelog.md#hospital-admissions)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From a2144bc42efd3ab876ddcd598db2ee5c7fd4075d Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:14:09 -0700 Subject: [PATCH 16/64] Update docs/api/covidcast-signals/indicator-combination.md Co-authored-by: george --- docs/api/covidcast-signals/indicator-combination.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index 5c7b094ba..e9fabd031 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -22,7 +22,7 @@ calculated or composed by Delphi. It is not a primary data source. ## Statistical Combination Signals * **Earliest issue available:** May 20, 2020 -* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) +* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) * **Date of last data revision:** June 3, 2020 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) * **Available for:** county, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From bddb07f1156e910b780e29a887a7c88b3416babf Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:14:24 -0700 Subject: [PATCH 17/64] Update docs/api/covidcast-signals/indicator-combination.md Co-authored-by: george --- docs/api/covidcast-signals/indicator-combination.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index e9fabd031..6a9f05dd4 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -191,9 +191,9 @@ The resampling method for each input source is as follows: ## Compositional Signals: Confirmed Cases and Deaths -* **Earliest issue available:** 7 July, 2020 -* **Number of data revisions since 19 May 2020:** 1 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) -* **Date of last data revision:** 12 October, 2020 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) +* **Earliest issue available:** July 7, 2020 +* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) +* **Date of last data revision:** October 12, 2020 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) * **Available for:** county, msa, hrr, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From 57c3fbe26b8fab074e66c730ae04f01dd04cafc7 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:14:32 -0700 Subject: [PATCH 18/64] Update docs/api/covidcast-signals/jhu-csse.md Co-authored-by: george --- docs/api/covidcast-signals/jhu-csse.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/jhu-csse.md b/docs/api/covidcast-signals/jhu-csse.md index 04ba8c731..bbff4b226 100644 --- a/docs/api/covidcast-signals/jhu-csse.md +++ b/docs/api/covidcast-signals/jhu-csse.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `jhu-csse` * **Earliest issue available:** May 7, 2020 -* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) +* **Number of data revisions since May 19, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) * **Date of last data revision:** October 7, 2020 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From 6ac5cfa946a331b9e05e6cafa156aef7cc4ae088 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:14:40 -0700 Subject: [PATCH 19/64] Update docs/api/covidcast-signals/nchs-mortality.md Co-authored-by: george --- docs/api/covidcast-signals/nchs-mortality.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/nchs-mortality.md b/docs/api/covidcast-signals/nchs-mortality.md index 3dfde30cb..337eafc0a 100644 --- a/docs/api/covidcast-signals/nchs-mortality.md +++ b/docs/api/covidcast-signals/nchs-mortality.md @@ -10,7 +10,7 @@ nav_order: 1 * **Source name:** `nchs-mortality` * **Earliest issue available:** Epiweek 50 2020 (6-12 December 2020) -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#nchs-mortality)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#nchs-mortality)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#nchs-mortality)) * **Available for:** state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** week (see [date format docs](../covidcast_times.md)) From 47b9e51702c1e68a867cb9304eb46f83cfc1d19f Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:15:02 -0700 Subject: [PATCH 20/64] Apply suggestions from code review Co-authored-by: george --- docs/api/covidcast-signals/nhsn.md | 2 +- docs/api/covidcast-signals/nssp.md | 2 +- docs/api/covidcast-signals/quidel.md | 4 ++-- docs/api/covidcast-signals/safegraph.md | 2 +- docs/api/covidcast-signals/usa-facts.md | 2 +- docs/api/covidcast-signals/youtube-survey.md | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/covidcast-signals/nhsn.md b/docs/api/covidcast-signals/nhsn.md index ef95c2f29..d926d5f9f 100644 --- a/docs/api/covidcast-signals/nhsn.md +++ b/docs/api/covidcast-signals/nhsn.md @@ -9,7 +9,7 @@ nav_order: 1 * **Source name:** `nhsn` * **Earliest issue available:** November 19, 2024 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#nhsn)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#nhsn)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#nhsn)) * **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** week (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/nssp.md b/docs/api/covidcast-signals/nssp.md index 27241a4c3..aa343b57a 100644 --- a/docs/api/covidcast-signals/nssp.md +++ b/docs/api/covidcast-signals/nssp.md @@ -9,7 +9,7 @@ nav_order: 1 * **Source name:** `nssp` * **Earliest issue available:** April 17, 2024 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#nssp)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#nssp)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#nssp)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** week (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/quidel.md b/docs/api/covidcast-signals/quidel.md index 381ad9cc7..3cc6460bb 100644 --- a/docs/api/covidcast-signals/quidel.md +++ b/docs/api/covidcast-signals/quidel.md @@ -20,7 +20,7 @@ nav_order: 1 * **Source name:** `quidel` * **Earliest issue available:** July 29, 2020 -* **Number of data revisions since 19 May, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#quidel)) +* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#quidel)) * **Date of last data revision:** October 22, 2020 (see [data revision docs](../covidcast_changelog.md#quidel)) * **Available for:** county, hrr, msa, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) @@ -168,7 +168,7 @@ These signals are inactive. They were updated until May 19, 2020. * **Source name:** `quidel` * **Earliest issue available:** April 29, 2020 * **Last issued:** May 19, 2020 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#quidel)) +* **Number of data revisions since May 19, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#quidel)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#quidel)) * **Available for:** msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index 3202d90b9..963d00933 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -26,7 +26,7 @@ surface signals from two such datasets. ## SafeGraph Social Distancing Metrics * **Earliest issue available:** June 20, 2020 -* **Number of data revisions since 23 June, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#safegraph)) +* **Number of data revisions since June 23, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#safegraph)) * **Date of last data revision:** November 3, 2020 (see [data revision docs](../covidcast_changelog.md#safegraph)) **This dataset is no longer updated after April 19th, 2021.** diff --git a/docs/api/covidcast-signals/usa-facts.md b/docs/api/covidcast-signals/usa-facts.md index 722032a14..534d568cd 100644 --- a/docs/api/covidcast-signals/usa-facts.md +++ b/docs/api/covidcast-signals/usa-facts.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `usa-facts` * **Earliest issue available:** June 24, 2020 -* **Number of data revisions since 19 May, 2020:** 2 (see [data revision docs](../covidcast_changelog.md#usa-facts)) +* **Number of data revisions:** 2 (see [data revision docs](../covidcast_changelog.md#usa-facts)) * **Date of last data revision:** November 3, 2020 (see [data revision docs](../covidcast_changelog.md#usa-facts)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/youtube-survey.md b/docs/api/covidcast-signals/youtube-survey.md index 4d9f395f1..8271c7ce7 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -12,7 +12,7 @@ nav_order: 2 * **Source name:** `youtube-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions since 19 May, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#youtube-survey)) +* **Number of data revisions since May 19, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#youtube-survey)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#youtube-survey)) * **Available for:** state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) From 1aa259ef72c0f8e04c4f5b114b6586125b6f37c2 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Mon, 23 Jun 2025 16:33:00 -0700 Subject: [PATCH 21/64] doc: change "Number of data revisions since X" to "Number of data revisions" --- .../covidcast-signals/covid-trends-and-impact-survey.md | 2 +- docs/api/covidcast-signals/doctor-visits.md | 2 +- docs/api/covidcast-signals/ght.md | 2 +- docs/api/covidcast-signals/google-survey.md | 2 +- docs/api/covidcast-signals/google-symptoms.md | 2 +- docs/api/covidcast-signals/jhu-csse.md | 2 +- docs/api/covidcast-signals/quidel.md | 8 ++++---- docs/api/covidcast-signals/youtube-survey.md | 2 +- docs/api/covidcast_changelog.md | 2 +- 9 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md index b9ddf7621..a44cea150 100644 --- a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -11,7 +11,7 @@ permalink: api/covidcast-signals/fb-survey.html * **Source name:** `fb-survey` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since May 19, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#fb-survey)) +* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#fb-survey)) * **Date of last data revision:** June 3, 2020 (see [data revision docs](../covidcast_changelog.md#fb-survey)) * **Available for:** county, hrr, msa, state, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/doctor-visits.md b/docs/api/covidcast-signals/doctor-visits.md index e1eb40391..9bd31100e 100644 --- a/docs/api/covidcast-signals/doctor-visits.md +++ b/docs/api/covidcast-signals/doctor-visits.md @@ -10,7 +10,7 @@ nav_order: 1 * **Source name:** `doctor-visits` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since May 19, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) +* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) * **Date of last data revision:** November 9, 2020 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/ght.md b/docs/api/covidcast-signals/ght.md index 6839dd44f..b7b65d577 100644 --- a/docs/api/covidcast-signals/ght.md +++ b/docs/api/covidcast-signals/ght.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `ght` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since May 19, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#ght)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#ght)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#ght)) * **Available for:** dma, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md index 9857c9249..ae8621b0e 100644 --- a/docs/api/covidcast-signals/google-survey.md +++ b/docs/api/covidcast-signals/google-survey.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `google-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions since May 19, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#google-survey)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#google-survey)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#google-survey)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index 2f979c70d..836232f26 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -10,7 +10,7 @@ nav_order: 1 * **Source name:** `google-symptoms` * **Earliest issue available:** Aug 20, 2017 -* **Number of data revisions since May 19, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) +* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) * **Date of last data revision:** February 28, 2025 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) * **Available for:** county, MSA, HRR, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/jhu-csse.md b/docs/api/covidcast-signals/jhu-csse.md index bbff4b226..dc6a40980 100644 --- a/docs/api/covidcast-signals/jhu-csse.md +++ b/docs/api/covidcast-signals/jhu-csse.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `jhu-csse` * **Earliest issue available:** May 7, 2020 -* **Number of data revisions since May 19, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) +* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) * **Date of last data revision:** October 7, 2020 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/quidel.md b/docs/api/covidcast-signals/quidel.md index 3cc6460bb..56bd98ac5 100644 --- a/docs/api/covidcast-signals/quidel.md +++ b/docs/api/covidcast-signals/quidel.md @@ -20,8 +20,8 @@ nav_order: 1 * **Source name:** `quidel` * **Earliest issue available:** July 29, 2020 -* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#quidel)) -* **Date of last data revision:** October 22, 2020 (see [data revision docs](../covidcast_changelog.md#quidel)) +* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#quidel-covid)) +* **Date of last data revision:** October 22, 2020 (see [data revision docs](../covidcast_changelog.md#quidel-covid)) * **Available for:** county, hrr, msa, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) @@ -168,8 +168,8 @@ These signals are inactive. They were updated until May 19, 2020. * **Source name:** `quidel` * **Earliest issue available:** April 29, 2020 * **Last issued:** May 19, 2020 -* **Number of data revisions since May 19, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#quidel)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#quidel)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#quidel-flu)) +* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#quidel-flu)) * **Available for:** msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast-signals/youtube-survey.md b/docs/api/covidcast-signals/youtube-survey.md index 8271c7ce7..d93bf2bdc 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -12,7 +12,7 @@ nav_order: 2 * **Source name:** `youtube-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions since May 19, 2020:** 0 (see [data revision docs](../covidcast_changelog.md#youtube-survey)) +* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#youtube-survey)) * **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#youtube-survey)) * **Available for:** state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) diff --git a/docs/api/covidcast_changelog.md b/docs/api/covidcast_changelog.md index f1efed34e..f6fa3e5d0 100644 --- a/docs/api/covidcast_changelog.md +++ b/docs/api/covidcast_changelog.md @@ -90,7 +90,7 @@ Standard errors are now included in the `nmf_day_doc_fbc_fbs_ght` signal for all The 10 October 2020 issue of all `indicator-combination` deaths signals has been removed from the API. These signals are primarily constructed of USAFacts data, whose 10 October 2020 issue was discovered to be corrupt on 11 October and repaired on 12 October. Subsequent issues have adequate coverage of all regions and dates included in the 10 October issue, so this change only affects forecasters who intend to pull training data with an `as_of` or `issues` parameter set to 20201010. -### `quidel` +### `quidel-covid` #### 22 October 2020 We went from a custom geo mapping file (for aggregating from zip->(county, msa, hrr, state)) to a central geo file based on rigorously sourced US census data. From a56cf2a38a0fde1c69ca00924bc2bce78dc7635f Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Tue, 24 Jun 2025 13:45:28 -0700 Subject: [PATCH 22/64] doc: consolidate changelogs in each source page under dropdown --- .../api/covidcast-signals/_source-template.md | 12 +- docs/api/covidcast-signals/chng.md | 14 ++- docs/api/covidcast-signals/covid-act-now.md | 16 ++- .../covid-trends-and-impact-survey.md | 31 ++++- docs/api/covidcast-signals/doctor-visits.md | 14 ++- docs/api/covidcast-signals/dsew-cpr.md | 16 ++- docs/api/covidcast-signals/ght.md | 14 ++- docs/api/covidcast-signals/google-survey.md | 14 ++- docs/api/covidcast-signals/google-symptoms.md | 3 +- docs/api/covidcast-signals/hhs.md | 16 ++- .../covidcast-signals/hospital-admissions.md | 15 ++- .../indicator-combination.md | 41 ++++++- docs/api/covidcast-signals/jhu-csse.md | 30 ++++- docs/api/covidcast-signals/nchs-mortality.md | 16 ++- docs/api/covidcast-signals/nhsn.md | 15 ++- docs/api/covidcast-signals/nssp.md | 14 ++- docs/api/covidcast-signals/quidel.md | 42 +++++-- docs/api/covidcast-signals/safegraph.md | 43 ++++++- docs/api/covidcast-signals/usa-facts.md | 22 +++- docs/api/covidcast-signals/youtube-survey.md | 15 ++- docs/api/covidcast_changelog.md | 108 ++---------------- 21 files changed, 363 insertions(+), 148 deletions(-) diff --git a/docs/api/covidcast-signals/_source-template.md b/docs/api/covidcast-signals/_source-template.md index 0dcccff6e..a13efd3ff 100644 --- a/docs/api/covidcast-signals/_source-template.md +++ b/docs/api/covidcast-signals/_source-template.md @@ -9,8 +9,7 @@ grand_parent: Main Endpoint (COVIDcast) * **Source name:** `SOURCE-API-NAME` * **Earliest issue available:** DATE RELEASED TO API -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#template)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#template)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [LICENSE NAME](../covidcast_licensing.md#APPLICABLE-SECTION) @@ -21,6 +20,15 @@ A brief description of what this source measures. |---------------|----------------------------------------------------------------------------------------------------------| | `signal_name` | Brief description of the signal, including the units it is measured in and any smoothing that is applied | +## Changelog + +
+Click to expand + +Your collapsible content goes here. You can still use **Markdown** inside. + +
+ ## Table of contents {: .no_toc .text-delta} diff --git a/docs/api/covidcast-signals/chng.md b/docs/api/covidcast-signals/chng.md index 95441c98c..1886ad289 100644 --- a/docs/api/covidcast-signals/chng.md +++ b/docs/api/covidcast-signals/chng.md @@ -10,12 +10,22 @@ nav_order: 1 * **Source name:** `chng` * **Earliest issue available:** November 4, 2020 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#chng)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#chng)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes so far. + +
+ ## Overview **Notice: This data source was inactive between 2021-10-04 and 2021-12-02 to allow us resolve some problems with the data pipeline. We have resumed daily updates and are working on a data patch to fill the gap. [Additional details on this inactive period are available below](#pipeline-pause).** diff --git a/docs/api/covidcast-signals/covid-act-now.md b/docs/api/covidcast-signals/covid-act-now.md index ec0f6bd37..29a80ace6 100644 --- a/docs/api/covidcast-signals/covid-act-now.md +++ b/docs/api/covidcast-signals/covid-act-now.md @@ -10,12 +10,24 @@ nav_order: 2 * **Source name:** `covid-act-now` * **Earliest issue available:** March 25, 2021 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#covid-act-now)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#covid-act-now)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes so far. + +
+ +## Overview + The [COVID Act Now (CAN)](https://covidactnow.org/) data source provides COVID-19 testing statistics, such as positivity rates and total tests performed. The county-level positivity rates and test totals are pulled directly from CAN using [their API](https://covidactnow.org/data-api). While CAN provides this data potentially from multiple sources, we only use data that CAN sources from the diff --git a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md index a44cea150..3e27fe373 100644 --- a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -11,12 +11,41 @@ permalink: api/covidcast-signals/fb-survey.html * **Source name:** `fb-survey` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#fb-survey)) * **Date of last data revision:** June 3, 2020 (see [data revision docs](../covidcast_changelog.md#fb-survey)) * **Available for:** county, hrr, msa, state, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### June 3, 2020 + +Duplicate survey weights had corrupted historical figures for the following signals and dates. The correct data has been restored to the API. +* `raw_wcli` + * `county`: 20200406, 20200408, 20200410, 20200430 + * `hrr`: 20200406, 20200408-20200410, 20200430 + * `msa`: 20200408, 20200410, 20200430 + * `state`: 20200408-20200410, 20200430 +* `smoothed_wcli` + * `county`: 20200406, 20200408-20200414, 20200430-20200506 + * `hrr`: 20200406-20200415, 20200430-20200506 + * `msa`: 20200408-20200414, 20200430-20200506 + * `state`: 20200408-20200416, 20200430-20200506 + +### November 20, 2020 + +Due to a bug in our data processing system, estimates of the percentage of people reporting that they have been tested for COVID-19 calculated before October 8th were incorrect. +We incorrectly treated an answer of “no” as a missing response, which affected the `smoothed_tested_14d` and `smoothed_wtested_14d` signals from the `fb-survey` source. + +As of Nov. 20th, the error has been corrected and all affected data reissued. + +
+ ## Overview This data source is based on the [COVID-19 Trends and Impact Survey (CTIS)](../../symptom-survey/) diff --git a/docs/api/covidcast-signals/doctor-visits.md b/docs/api/covidcast-signals/doctor-visits.md index 9bd31100e..71865f948 100644 --- a/docs/api/covidcast-signals/doctor-visits.md +++ b/docs/api/covidcast-signals/doctor-visits.md @@ -10,12 +10,22 @@ nav_order: 1 * **Source name:** `doctor-visits` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) -* **Date of last data revision:** November 9, 2020 (see [data revision docs](../covidcast_changelog.md#doctor-visits)) +* **Date of last data revision:** November 9, 2020 (see [data revision docs](#changelog)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### November 9, 2020 +We went from a custom geo-mapping file (for aggregating from county->(msa, hrr, state)) to a central geo file based on rigorously sourced US census data. + +
## Overview diff --git a/docs/api/covidcast-signals/dsew-cpr.md b/docs/api/covidcast-signals/dsew-cpr.md index 1898d1760..f1a65cbaf 100644 --- a/docs/api/covidcast-signals/dsew-cpr.md +++ b/docs/api/covidcast-signals/dsew-cpr.md @@ -10,12 +10,24 @@ nav_order: 2 * **Source name:** `dsew-cpr` * **Earliest issue available:** January 28, 2022 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#dsew-cpr)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#dsew-cpr)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** county, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes so far. + +
+ +## Overview + The Community Profile Report (CPR) is published by the Data Strategy and Execution Workgroup (DSEW) of the White House COVID-19 Team. For more information, see the [official description at healthdata.gov](https://healthdata.gov/Health/COVID-19-Community-Profile-Report/gqxm-d9w9) for "COVID-19 Community Profile Report". Each issue of the CPR is made available as an attachment on that page. You can view all attachments by scrolling to the bottom of the "About this dataset" panel and clicking "Show more". This data source provides various COVID-19 related metrics, of which we report hospital admissions and vaccinations. diff --git a/docs/api/covidcast-signals/ght.md b/docs/api/covidcast-signals/ght.md index b7b65d577..a80a86a4d 100644 --- a/docs/api/covidcast-signals/ght.md +++ b/docs/api/covidcast-signals/ght.md @@ -10,11 +10,21 @@ nav_order: 2 * **Source name:** `ght` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#ght)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#ght)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** dma, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes so far. + +
+ ## Overview This data source (`ght`) is based on Google searches, provided to us by Google diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md index ae8621b0e..ca42ab7b9 100644 --- a/docs/api/covidcast-signals/google-survey.md +++ b/docs/api/covidcast-signals/google-survey.md @@ -10,12 +10,22 @@ nav_order: 2 * **Source name:** `google-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#google-survey)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#google-survey)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes so far. + +
+ ## Overview Data source based on [Google-run symptom surveys](https://9to5google.com/2020/03/23/google-coronavirus-survey/), through publisher websites, diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index 836232f26..13f8e1c9f 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -10,8 +10,7 @@ nav_order: 1 * **Source name:** `google-symptoms` * **Earliest issue available:** Aug 20, 2017 -* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) -* **Date of last data revision:** February 28, 2025 (see [data revision docs](../covidcast_changelog.md#google-symptoms)) +* **Date of last data revision:** March 14, 2025 (see [data revision docs](#changelog)) * **Available for:** county, MSA, HRR, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** To download or use the data, you must agree to the Google [Terms of Service](https://policies.google.com/terms) diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index e39dfd4f7..dba2e1990 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -10,12 +10,24 @@ nav_order: 2 * **Source name:** `hhs` * **Earliest issue available:** November 16, 2020 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#hhs)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#hhs)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes so far. + +
+ +## Overview + The U.S. Department of Health & Human Services (HHS) publishes several 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 diff --git a/docs/api/covidcast-signals/hospital-admissions.md b/docs/api/covidcast-signals/hospital-admissions.md index 152249a44..a76e44a65 100644 --- a/docs/api/covidcast-signals/hospital-admissions.md +++ b/docs/api/covidcast-signals/hospital-admissions.md @@ -10,12 +10,23 @@ nav_order: 1 * **Source name:** `hospital-admissions` * **Earliest issue available:** June 21, 2020 -* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#hospital-admissions)) -* **Date of last data revision:** October 20, 2020 (see [data revision docs](../covidcast_changelog.md#hospital-admissions)) +* **Date of last data revision:** October 20, 2020 (see [data revision docs](#changelog)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### October 20, 2020 +We went from a custom geo mapping file (for aggregating from zip->(county, msa, hrr, state)) to a central geo file based on rigorously sourced US census data. + +
+ ## Overview This data source is based on electronic medical records and claims data about diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index 6a9f05dd4..e71e77adc 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -22,12 +22,30 @@ calculated or composed by Delphi. It is not a primary data source. ## Statistical Combination Signals * **Earliest issue available:** May 20, 2020 -* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) -* **Date of last data revision:** June 3, 2020 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) +* **Date of last data revision:** June 3, 2020 (see [data revision docs](#changelog)) * **Available for:** county, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### June 3, 2020 + +Standard errors are now included in the `nmf_day_doc_fbc_fbs_ght` signal for all geo levels and dates, representing the estimated uncertainty in this signal. This uncertainty comes because the signal is a combination of other signals based on survey estimates or other estimates with margins of error. + +* `nmf_day_doc_fbc_fbs_ght` + * all geo levels + * all dates + +
+ +## Overview + These signals combine Delphi's indicators---*not* including cases and deaths, but including other signals expected to be related to the underlying rate of coronavirus infection---to produce a single indicator. The goal is to provide a @@ -192,11 +210,26 @@ The resampling method for each input source is as follows: ## Compositional Signals: Confirmed Cases and Deaths * **Earliest issue available:** July 7, 2020 -* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) -* **Date of last data revision:** October 12, 2020 (see [data revision docs](../covidcast_changelog.md#indicator-combination)) +* **Date of last data revision:** October 12, 2020 (see [data revision docs](#changelog-deaths)) * **Available for:** county, msa, hrr, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) +## Changelog Deaths + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### October 12, 2020 + +The 10 October 2020 issue of all `indicator-combination` deaths signals has been removed from the API. These signals are primarily constructed of USAFacts data, whose 10 October 2020 issue was discovered to be corrupt on 11 October and repaired on 12 October. Subsequent issues have adequate coverage of all regions and dates included in the 10 October issue, so this change only affects forecasters who intend to pull training data with an `as_of` or `issues` parameter set to 20201010. + +
+ + +## Overview + These signals combine the cases and deaths data from JHU and USA Facts. This is a straight composition: the signals below use the [JHU signal data](jhu-csse.md) for Puerto Rico, and the [USA Facts signal data](usa-facts.md) everywhere else. diff --git a/docs/api/covidcast-signals/jhu-csse.md b/docs/api/covidcast-signals/jhu-csse.md index dc6a40980..7f6c9425e 100644 --- a/docs/api/covidcast-signals/jhu-csse.md +++ b/docs/api/covidcast-signals/jhu-csse.md @@ -10,12 +10,38 @@ nav_order: 2 * **Source name:** `jhu-csse` * **Earliest issue available:** May 7, 2020 -* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) -* **Date of last data revision:** October 7, 2020 (see [data revision docs](../covidcast_changelog.md#jhu-csse)) +* **Date of last data revision:** October 7, 2020 (see [data revision docs](#changelog)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](#source-and-licensing) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### October 7, 2020 + +The following changes were made to all `jhu-csse` signals related to geocoding: +- NY Boroughs county FIPS (36005, 36047, 36061, 36081, 36085) are now [differentiated by JHU](https://github.com/CSSEGISandData/COVID-19/issues/3084), +- “Unassigned” and “Out of State” counts are assigned to a megaFIPS at the county level (XX000 where XX is the state FIPS code) and will now be incorporated into the state totals +- The split of the Kansas City, Missouri into its four sub-counties is now done with a more precise population proportion, +- The split of the Dukes and Nantucket, Massachusetts FIPS codes into the two sub-counties is now done with a more precise population proportion, +- Some counts are reported in the Utah territories JHU UIDs 84070015-84070020. These are now aggregated properly into the state megaFIPS 49000, which will be aggregated in state-level information. + +### September 1, 2020 + +NY Boroughs county FIPS (36005, 36047, 36061, 36081, 36085) are now split in proportion to the population of each county, instead of being reported in aggregate in FIPS 36061. + +### June 3, 2020 + +We now include figures on Puerto Rico for all `jhu-csse` signals at the state level. + +
+ + ## Overview This data source of confirmed COVID-19 cases and deaths is based on reports made diff --git a/docs/api/covidcast-signals/nchs-mortality.md b/docs/api/covidcast-signals/nchs-mortality.md index 337eafc0a..65c1ee97b 100644 --- a/docs/api/covidcast-signals/nchs-mortality.md +++ b/docs/api/covidcast-signals/nchs-mortality.md @@ -10,12 +10,24 @@ nav_order: 1 * **Source name:** `nchs-mortality` * **Earliest issue available:** Epiweek 50 2020 (6-12 December 2020) -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#nchs-mortality)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#nchs-mortality)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** week (see [date format docs](../covidcast_times.md)) * **License:** [NCHS Data Use Agreement](https://www.cdc.gov/nchs/data_access/restrictions.htm) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes so far. + +
+ +## Overview + This data source of national provisional death counts is based on death certificate data received and coded by the National Center for Health Statistics [(NCHS)](https://www.cdc.gov/nchs/nvss/vsrr/COVID19/index.htm). This data is diff --git a/docs/api/covidcast-signals/nhsn.md b/docs/api/covidcast-signals/nhsn.md index d926d5f9f..8f8b1701a 100644 --- a/docs/api/covidcast-signals/nhsn.md +++ b/docs/api/covidcast-signals/nhsn.md @@ -9,12 +9,23 @@ nav_order: 1 * **Source name:** `nhsn` * **Earliest issue available:** November 19, 2024 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#nhsn)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#nhsn)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** week (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes so far. + +
+ + ## Overview [The National Healthcare Safety Network (NHSN)](https://www.cdc.gov/nhsn/index.html) is the nation’s most widely used healthcare-associated infection tracking system. diff --git a/docs/api/covidcast-signals/nssp.md b/docs/api/covidcast-signals/nssp.md index aa343b57a..e5871a67b 100644 --- a/docs/api/covidcast-signals/nssp.md +++ b/docs/api/covidcast-signals/nssp.md @@ -9,12 +9,22 @@ nav_order: 1 * **Source name:** `nssp` * **Earliest issue available:** April 17, 2024 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#nssp)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#nssp)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** week (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes so far. + +
+ ## Overview [The National Syndromic Surveillance Program (NSSP)](https://www.cdc.gov/nssp/php/about/index.html) is an effort to track epidemiologically relevant conditions. diff --git a/docs/api/covidcast-signals/quidel.md b/docs/api/covidcast-signals/quidel.md index 56bd98ac5..894942990 100644 --- a/docs/api/covidcast-signals/quidel.md +++ b/docs/api/covidcast-signals/quidel.md @@ -20,13 +20,24 @@ nav_order: 1 * **Source name:** `quidel` * **Earliest issue available:** July 29, 2020 -* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#quidel-covid)) -* **Date of last data revision:** October 22, 2020 (see [data revision docs](../covidcast_changelog.md#quidel-covid)) +* **Date of last data revision:** October 22, 2020 (see [data revision docs](#changelog-covid-19-tests)) * **Available for:** county, hrr, msa, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) -### Overview +## Changelog COVID-19 Tests + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### October 22, 2020 +We went from a custom geo mapping file (for aggregating from zip->(county, msa, hrr, state)) to a central geo file based on rigorously sourced US census data. + +
+ +## Overview Data source based on COVID-19 Antigen tests, provided to us by Quidel, Inc. When a patient (whether at a doctor’s office, clinic, or hospital) has COVID-like @@ -54,7 +65,7 @@ meaningful levels starting May 26, 2020. | `covid_ag_smoothed_pct_positive_age_65plus` | Percentage of antigen tests that were positive for COVID-19 (ages 65+), smoothed by pooling together the last 7 days of tests.
**Earliest date available:** 2020-05-26 | | `covid_ag_smoothed_pct_positive_age_0_17` | Percentage of antigen tests that were positive for COVID-19 (ages 0-17), smoothed by pooling together the last 7 days of tests.
**Earliest date available:** 2020-05-26 | -### Estimation +## Estimation The source data from which we derive our estimates contains a number of features for every test, including localization at 5-digit Zip Code level, a TestDate and @@ -80,7 +91,7 @@ We estimate p across 6 temporal-spatial aggregation schemes: - daily, at the HHS level; - daily, at the US national level. -#### Standard Error +### Standard Error We assume the estimates for each time point follow a binomial distribution. The estimated standard error then is: @@ -89,11 +100,11 @@ $$ \text{se} = 100 \sqrt{ \frac{\frac{p}{100}(1- \frac{p}{100})}{N} } $$ -#### Smoothing +### Smoothing We add two kinds of smoothing to the smoothed signals: -##### Temporal Smoothing +#### Temporal Smoothing Smoothed estimates are formed by pooling data over time. That is, daily, for each location, we first pool all data available in that location over the last 7 days, and we then recompute everything described in the two subsections above. @@ -101,7 +112,7 @@ days, and we then recompute everything described in the two subsections above. Pooling in this way makes estimates available in more geographic areas, as many areas report very few tests per day, but have enough data to report when 7 days are considered. -##### Geographical Smoothing +#### Geographical Smoothing **County, MSA and HRR levels**: In a given County, MSA or HRR, suppose $$N$$ COVID tests are taken in a certain time period, $$X$$ is the number of tests taken with positive @@ -168,12 +179,21 @@ These signals are inactive. They were updated until May 19, 2020. * **Source name:** `quidel` * **Earliest issue available:** April 29, 2020 * **Last issued:** May 19, 2020 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#quidel-flu)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#quidel-flu)) +* **Date of last data revision:** Never (see [data revision docs](#changelog-flu-tests)) * **Available for:** msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) -### Overview +## Changelog Flu Tests + +
+Click to expand + +### October 22, 2020 +We went from a custom geo mapping file (for aggregating from zip->(county, msa, hrr, state)) to a central geo file based on rigorously sourced US census data. + +
+ +## Overview Data source based on flu lab tests, provided to us by Quidel, Inc. When a patient (whether at a doctor’s office, clinic, or hospital) has COVID-like diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index 963d00933..873d2d4d5 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -26,11 +26,29 @@ surface signals from two such datasets. ## SafeGraph Social Distancing Metrics * **Earliest issue available:** June 20, 2020 -* **Number of data revisions since June 23, 2020:** 1 (see [data revision docs](../covidcast_changelog.md#safegraph)) -* **Date of last data revision:** November 3, 2020 (see [data revision docs](../covidcast_changelog.md#safegraph)) +* **Date of last data revision:** November 3, 2020 (see [data revision docs](#changelog-social-distancing-metrics)) **This dataset is no longer updated after April 19th, 2021.** +## Changelog (Social Distancing Metrics) + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### April 19, 2021 + +The Safegraph social distancing metrics are no longer being updated. Weekly patterns are still available. + +### November 3, 2020 + +We went from a custom geo mapping file (for aggregating from county->state) to a central geo file based on rigorously sourced US census data. + +
+ +## Overview + Data source based on the [Social Distancing Metrics](https://docs.safegraph.com/docs/social-distancing-metrics) data product. SafeGraph provided this data for individual census block groups, using differential privacy to protect individual people's data privacy. @@ -77,11 +95,28 @@ additional day for SafeGraph's data to be ingested into the COVIDcast API. ## SafeGraph Weekly Patterns * **Earliest issue available:** November 30, 2020 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#safegraph)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#safegraph)) +* **Date of last data revision:** Never (see [data revision docs](#changelog-weekly-patterns)) **This dataset is no longer updated after July 15th, 2022.** +## Changelog (Weekly Patterns) + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### July 15, 2022 +The Safegraph Weekly Patterns dataset is no longer updated. + +### November 3, 2020 + +We went from a custom geo mapping file (for aggregating from county->state) to a central geo file based on rigorously sourced US census data. + +
+ +## Overview + Data source based on [Weekly Patterns](https://docs.safegraph.com/docs/weekly-patterns) dataset. SafeGraph provided this data for different points of interest diff --git a/docs/api/covidcast-signals/usa-facts.md b/docs/api/covidcast-signals/usa-facts.md index 534d568cd..8db886ba1 100644 --- a/docs/api/covidcast-signals/usa-facts.md +++ b/docs/api/covidcast-signals/usa-facts.md @@ -10,12 +10,30 @@ nav_order: 2 * **Source name:** `usa-facts` * **Earliest issue available:** June 24, 2020 -* **Number of data revisions:** 2 (see [data revision docs](../covidcast_changelog.md#usa-facts)) -* **Date of last data revision:** November 3, 2020 (see [data revision docs](../covidcast_changelog.md#usa-facts)) +* **Date of last data revision:** November 3, 2020 (see [data revision docs](#changelog)) * **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](#source-and-licensing) +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +### November 3, 2020 +We went from a custom geo mapping file (for aggregating from county->(msa, hrr, state)) to a central geo file based on rigorously sourced US census data. + +### October 12, 2020 + +The 10 October 2020 issue of all `usa-facts` deaths signals has been removed from the API. The file for deaths provided by USAFacts on 10 October included case data instead. The resulting spurious 100× increase in magnitude of COVIDcast `usa-facts` deaths signals was noticed on 11 October and repaired on 12 October. Subsequent issues have adequate coverage of all regions and dates included in the 10 October issue, so this change only affects forecasters that intend to pull training data with an `as_of` or `issues` parameter set to 20201010. + +
+ + +## Overview + This data source of confirmed COVID-19 cases and deaths is based on reports made available by [USAFacts](https://usafacts.org/). diff --git a/docs/api/covidcast-signals/youtube-survey.md b/docs/api/covidcast-signals/youtube-survey.md index d93bf2bdc..923f550e1 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -12,12 +12,23 @@ nav_order: 2 * **Source name:** `youtube-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#youtube-survey)) -* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#youtube-survey)) +* **Date of last data revision:** Never (see [data revision docs](#changelog)) * **Available for:** state (see [geography coding docs](../covidcast_geography.md)) * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) + +## Changelog + +
+Click to expand + +See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. + +No changes have been made to this signal. + +
+ ## Overview This data source is based on a short survey about COVID-19-like illness diff --git a/docs/api/covidcast_changelog.md b/docs/api/covidcast_changelog.md index f6fa3e5d0..204cd3553 100644 --- a/docs/api/covidcast_changelog.md +++ b/docs/api/covidcast_changelog.md @@ -4,7 +4,13 @@ parent: Main Endpoint (COVIDcast) nav_order: 8 --- -# COVIDcast Signal Changelog +# COVIDcast Signal Changes + +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} When Delphi makes substantial changes to a signal's computation, we will typically publish it under a new name rather than revising the existing signal. @@ -17,98 +23,8 @@ we **strongly recommend** that anyone using the API to download data regularly should subscribe to this list. We will only use the list to announce API changes, data corrections, and other information relevant to API users. -For current information on how up-to-date our public health and behavior data is, how much of the country is covered by our public health and behavior data, and the data versioning effects present in our public health and behavior data, please see Delphi's [Indicator Status Overview page](https://delphi.cmu.edu/covidcast/indicator-status/). - -## Table of contents -{: .no_toc .text-delta} - -1. TOC -{:toc} - -## Sources and Signals -### `doctor-visits` -#### 9 November 2020 -We went from a custom geo-mapping file (for aggregating from county->(msa, hrr, state)) to a central geo file based on rigorously sourced US census data. - -### `fb-survey` - -#### 3 June 2020 - -Duplicate survey weights had corrupted historical figures for the following signals and dates. The correct data has been restored to the API. -* `raw_wcli` - * `county`: 20200406, 20200408, 20200410, 20200430 - * `hrr`: 20200406, 20200408-20200410, 20200430 - * `msa`: 20200408, 20200410, 20200430 - * `state`: 20200408-20200410, 20200430 -* `smoothed_wcli` - * `county`: 20200406, 20200408-20200414, 20200430-20200506 - * `hrr`: 20200406-20200415, 20200430-20200506 - * `msa`: 20200408-20200414, 20200430-20200506 - * `state`: 20200408-20200416, 20200430-20200506 - -#### 20 November 2020 - -Due to a bug in our data processing system, estimates of the percentage of people reporting that they have been tested for COVID-19 calculated before October 8th were incorrect. -We incorrectly treated an answer of “no” as a missing response, which affected the `smoothed_tested_14d` and `smoothed_wtested_14d` signals from the `fb-survey` source. - -As of Nov. 20th, the error has been corrected and all affected data reissued. - -### `hospital-admissions` -#### 20 October 2020 -We went from a custom geo mapping file (for aggregating from zip->(county, msa, hrr, state)) to a central geo file based on rigorously sourced US census data. - -### `jhu-csse` - -#### 3 June 2020 - -We now include figures on Puerto Rico for all `jhu-csse` signals at the state level. - -#### 1 September 2020 - -NY Boroughs county FIPS (36005, 36047, 36061, 36081, 36085) are now split in proportion to the population of each county, instead of being reported in aggregate in FIPS 36061. - -#### 7 October 2020 - -The following changes were made to all `jhu-csse` signals related to geocoding: -- NY Boroughs county FIPS (36005, 36047, 36061, 36081, 36085) are now [differentiated by JHU](https://github.com/CSSEGISandData/COVID-19/issues/3084), -- “Unassigned” and “Out of State” counts are assigned to a megaFIPS at the county level (XX000 where XX is the state FIPS code) and will now be incorporated into the state totals -- The split of the Kansas City, Missouri into its four sub-counties is now done with a more precise population proportion, -- The split of the Dukes and Nantucket, Massachusetts FIPS codes into the two sub-counties is now done with a more precise population proportion, -- Some counts are reported in the Utah territories JHU UIDs 84070015-84070020. These are now aggregated properly into the state megaFIPS 49000, which will be aggregated in state-level information. - -### `indicator-combination` - -#### 3 June 2020 - -Standard errors are now included in the `nmf_day_doc_fbc_fbs_ght` signal for all geo levels and dates, representing the estimated uncertainty in this signal. This uncertainty comes because the signal is a combination of other signals based on survey estimates or other estimates with margins of error. - -* `nmf_day_doc_fbc_fbs_ght` - * all geo levels - * all dates - -#### 12 October 2020 - -The 10 October 2020 issue of all `indicator-combination` deaths signals has been removed from the API. These signals are primarily constructed of USAFacts data, whose 10 October 2020 issue was discovered to be corrupt on 11 October and repaired on 12 October. Subsequent issues have adequate coverage of all regions and dates included in the 10 October issue, so this change only affects forecasters who intend to pull training data with an `as_of` or `issues` parameter set to 20201010. - -### `quidel-covid` - -#### 22 October 2020 -We went from a custom geo mapping file (for aggregating from zip->(county, msa, hrr, state)) to a central geo file based on rigorously sourced US census data. - -### `safegraph` - -#### 19 April 2021 - -The Safegraph social distancing metrics are no longer being updated. Weekly patterns are still available. - -#### 3 November 2020 -We went from a custom geo mapping file (for aggregating from county->state) to a central geo file based on rigorously sourced US census data. - -### `usa-facts` - -#### 3 November 2020 -We went from a custom geo mapping file (for aggregating from county->(msa, hrr, state)) to a central geo file based on rigorously sourced US census data. - -#### 12 October 2020 - -The 10 October 2020 issue of all `usa-facts` deaths signals has been removed from the API. The file for deaths provided by USAFacts on 10 October included case data instead. The resulting spurious 100× increase in magnitude of COVIDcast `usa-facts` deaths signals was noticed on 11 October and repaired on 12 October. Subsequent issues have adequate coverage of all regions and dates included in the 10 October issue, so this change only affects forecasters that intend to pull training data with an `as_of` or `issues` parameter set to 20201010. +For current information on how up-to-date our public health and behavior data +is, how much of the country is covered by our public health and behavior data, +and the data versioning effects present in our public health and behavior data, +please see Delphi's [Indicator Status Overview +page](https://delphi.cmu.edu/covidcast/indicator-status/). From 26ed1a97b5d96c857405df631606b34f5da655c8 Mon Sep 17 00:00:00 2001 From: Dmitry Shemetov Date: Tue, 24 Jun 2025 13:46:36 -0700 Subject: [PATCH 23/64] doc: update google symptoms changelog Co-authored-by: Amaris Sim --- docs/api/covidcast-signals/google-symptoms.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index 13f8e1c9f..05349daa0 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -15,6 +15,19 @@ nav_order: 1 * **Time type:** day (see [date format docs](../covidcast_times.md)) * **License:** To download or use the data, you must agree to the Google [Terms of Service](https://policies.google.com/terms) +## Changelog + +
+Click to expand + +### March 14, 2025 +Google added earlier dates starting from 2017-08-15 and also fixed a gap of county-level data from November 14 2022 through February 20, 2023. + +### February 14, 2025 +We added a new signal s07_raw_search and s07_smoothed_search. + +
+ ## Overview This data source is based on the [COVID-19 Search Trends symptoms From b14a9ddd7c36b78532334878e96f0e880d9ecb45 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 11 Nov 2025 10:17:57 -0800 Subject: [PATCH 24/64] docs: "change Surveillance Streams" term to indicators as specified in issue #298 --- docs/api/covidcast.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast.md b/docs/api/covidcast.md index d283fb8a8..1e3d4aa28 100644 --- a/docs/api/covidcast.md +++ b/docs/api/covidcast.md @@ -95,7 +95,7 @@ including confirmed cases, symptom-related search queries, hospitalizations, outpatient doctor's visits, and other sources. Many of these are publicly available *only* through the COVIDcast API. -Delphi's COVID-19 Surveillance Streams data includes the following data sources. +Delphi's COVID-19 indicators data includes the following data sources. Data from most of these sources is typically updated daily. You can use the [`covidcast_meta`](covidcast_meta.md) endpoint to get summary information about the ranges of the different attributes for the different data sources. From c26bc688b5e3bcd046ac4e103ede708fab3e4451 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 11 Nov 2025 10:21:45 -0800 Subject: [PATCH 25/64] docs: eliminate circular reference and fix link to client subsite --- docs/api/api_keys.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/api/api_keys.md b/docs/api/api_keys.md index 9db40bc80..6a37fc1a3 100644 --- a/docs/api/api_keys.md +++ b/docs/api/api_keys.md @@ -44,11 +44,12 @@ there are several ways to use your key to authenticate your requests: * [epidatr](https://cmu-delphi.github.io/epidatr/#api-keys) * [epidatpy](https://cmu-delphi.github.io/epidatpy/#api-keys) -* [delphi-epidata](https://cmu-delphi.github.io/delphi-epidata/api/client_libraries.html) * covidcast (deprecated in favor of `epidatr` and `epidatpy`) * [R client](https://cmu-delphi.github.io/covidcast/covidcastR/reference/covidcast_signal.html#api-keys-1) * [Python client](https://cmu-delphi.github.io/covidcast/covidcast-py/html/signals.html#covidcast.use_api_key) +More details on how to use the clients [here](api/client_libraries.html). + ### Via request parameter The request parameter “api_key” can be used to pass the API key to the server. From 5b68357df90cfbe13ea821a372f8c296c07fc6f7 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Mon, 17 Nov 2025 23:02:10 -0800 Subject: [PATCH 26/64] docs: correct links to COVID-19 Trends and Impact Survey --- docs/api/covidcast-signals/google-survey.md | 2 +- docs/api/covidcast.md | 8 ++++---- docs/api/covidcast_licensing.md | 2 +- docs/api/covidcast_signals.md | 8 ++++---- docs/symptom-survey/contingency-tables.md | 2 +- docs/symptom-survey/data-access.md | 2 +- docs/symptom-survey/index.md | 2 +- docs/symptom-survey/weights.md | 2 +- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md index d758d6a8b..27ef423dc 100644 --- a/docs/api/covidcast-signals/google-survey.md +++ b/docs/api/covidcast-signals/google-survey.md @@ -26,7 +26,7 @@ is sick (fever, along with cough, or shortness of breath, or difficulty breathing) right now?" Using this survey data, we estimate the percentage of people in a given location, on a given day, that *know somebody who has a COVID-like illness*. This estimates a similar quantity to the `*_cmnty_cli` -signals from the [COVID-19 Trends and Impact Survey](fb-survey.md) (`fb-survey`) source, but using +signals from the [COVID-19 Trends and Impact Survey](covid-trends-and-impact-survey.md) (`fb-survey`) source, but using a different survey population and recruitment method. The survey sampled from all counties with greater than 100,000 population, along diff --git a/docs/api/covidcast.md b/docs/api/covidcast.md index 1e3d4aa28..1a60a61fe 100644 --- a/docs/api/covidcast.md +++ b/docs/api/covidcast.md @@ -118,11 +118,11 @@ dashboard](https://delphi.cmu.edu/covidcast/): | Kind | Name | Source | Signal | |---|---|---|---| -| 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 | People Wearing Masks | [`fb-survey`](covidcast-signals/covid-trends-and-impact-survey.md) | `smoothed_wwearing_mask_7d` | +| Public Behavior | Vaccine Acceptance | [`fb-survey`](covidcast-signals/covid-trends-and-impact-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-Like Symptoms | [`fb-survey`](covidcast-signals/covid-trends-and-impact-survey.md) | `smoothed_wcli` | +| Early Indicators | COVID-Like Symptoms in Community | [`fb-survey`](covidcast-signals/covid-trends-and-impact-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` | diff --git a/docs/api/covidcast_licensing.md b/docs/api/covidcast_licensing.md index d6efaf62c..db454e737 100644 --- a/docs/api/covidcast_licensing.md +++ b/docs/api/covidcast_licensing.md @@ -34,7 +34,7 @@ Academic publications may cite our paper: These data sources are provided under the terms of the [Creative Commons Attribution license](https://creativecommons.org/licenses/by/4.0/): -* [COVID-19 Trends and Impact Survey](covidcast-signals/fb-survey.md) +* [COVID-19 Trends and Impact Survey](covidcast-signals/covid-trends-and-impact-survey.md) * [Doctor Visits](covidcast-signals/doctor-visits.md) * [Hospital Admissions](covidcast-signals/hospital-admissions.md) * [Indicator Combination](covidcast-signals/indicator-combination.md) (signals with names beginning `nmf_*`) diff --git a/docs/api/covidcast_signals.md b/docs/api/covidcast_signals.md index 1f5ce38b6..9a1f9e418 100644 --- a/docs/api/covidcast_signals.md +++ b/docs/api/covidcast_signals.md @@ -30,11 +30,11 @@ dashboard](https://delphi.cmu.edu/covidcast/): | Kind | Name | Source | Signal | |---|---|---|---| -| 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 | People Wearing Masks | [`fb-survey`](covidcast-signals/covid-trends-and-impact-survey.md) | `smoothed_wwearing_mask_7d` | +| Public Behavior | Vaccine Acceptance | [`fb-survey`](covidcast-signals/covid-trends-and-impact-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-Like Symptoms | [`fb-survey`](covidcast-signals/covid-trends-and-impact-survey.md) | `smoothed_wcli` | +| Early Indicators | COVID-Like Symptoms in Community | [`fb-survey`](covidcast-signals/covid-trends-and-impact-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` | diff --git a/docs/symptom-survey/contingency-tables.md b/docs/symptom-survey/contingency-tables.md index f92ee1ef4..b05a871aa 100644 --- a/docs/symptom-survey/contingency-tables.md +++ b/docs/symptom-survey/contingency-tables.md @@ -30,7 +30,7 @@ territories worldwide, also [through ICPSR](https://www.icpsr.umich.edu/web/ICPSR/studies/39206). These tables are more detailed than the [coarse aggregates reported in the -COVIDcast Epidata API](../api/covidcast-signals/fb-survey.md), which are grouped +COVIDcast Epidata API](../api/covidcast-signals/covid-trends-and-impact-survey.md), which are grouped only by geographic region. [Individual response data](survey-files.md) for the survey is available, but only to researchers who request restricted data access via ICPSR, whereas these contingency tables are available to the general public. diff --git a/docs/symptom-survey/data-access.md b/docs/symptom-survey/data-access.md index 435f07ee2..6c30c759c 100644 --- a/docs/symptom-survey/data-access.md +++ b/docs/symptom-survey/data-access.md @@ -13,7 +13,7 @@ well-being. This may help improve our local and national responses to the pandemic and our understanding of how it has affected society. [High-level aggregates](../api/covidcast.md) of select survey items are -publicly available in the [COVIDcast API](../api/covidcast-signals/fb-survey.md). +publicly available in the [COVIDcast API](../api/covidcast-signals/covid-trends-and-impact-survey.md). [Finer aggregates](./contingency-tables.md) grouped by various demographic characteristics are available for download. diff --git a/docs/symptom-survey/index.md b/docs/symptom-survey/index.md index 48b42b012..dbba7e899 100644 --- a/docs/symptom-survey/index.md +++ b/docs/symptom-survey/index.md @@ -40,7 +40,7 @@ If you have questions about the survey or getting access to data, contact us at The [survey results dashboard](https://delphi.cmu.edu/covidcast/survey-results/) provides a high-level summary of survey results. Geographically aggregated data from this survey is publicly available through the [COVIDcast API](../api/covidcast.md) -as the [`fb-survey` data source](../api/covidcast-signals/fb-survey.md). Demographic breakdowns of survey +as the [`fb-survey` data source](../api/covidcast-signals/covid-trends-and-impact-survey.md). Demographic breakdowns of survey data are publicly available as [downloadable contingency tables](contingency-tables.md). CTIS data has been used in [numerous peer-reviewed publications](publications.md). diff --git a/docs/symptom-survey/weights.md b/docs/symptom-survey/weights.md index 3cd1c60ee..a6a5df858 100644 --- a/docs/symptom-survey/weights.md +++ b/docs/symptom-survey/weights.md @@ -10,7 +10,7 @@ nav_order: 5 The survey's individual response files contain respondent weights calculated by Facebook. These weights are also used to produce our [public contingency tables](./contingency-tables.md) and the geographic aggregates -[in the COVIDcast Epidata API](../api/covidcast-signals/fb-survey.md). +[in the COVIDcast Epidata API](../api/covidcast-signals/covid-trends-and-impact-survey.md). Facebook has developed a [User Guide for the CTIS Weights](https://dataforgood.facebook.com/dfg/resources/user-guide-for-ctis-weights) From 50a40f29f58b95eca715e4e9f0ec30a14fbde61c Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 18 Nov 2025 00:06:01 -0800 Subject: [PATCH 27/64] docs: relocating "Constructing API Queries" as a subpage under "Main Endpoint (COVIDcast)" due to its detailed content. --- docs/api/covidcast.md | 181 +----------------------------- docs/api/covidcast_api_queries.md | 180 +++++++++++++++++++++++++++++ 2 files changed, 182 insertions(+), 179 deletions(-) create mode 100644 docs/api/covidcast_api_queries.md diff --git a/docs/api/covidcast.md b/docs/api/covidcast.md index 1a60a61fe..6e6d7fbce 100644 --- a/docs/api/covidcast.md +++ b/docs/api/covidcast.md @@ -82,8 +82,7 @@ data = apicall.df() [The API clients](covidcast_clients.md) have extensive documentation providing further examples. -Alternately, to construct URLs and parse responses to access data manually, [see -below](#constructing-api-queries) for details. +Alternatively, to manually construct URLs and parse responses to access data, [refer to this section](covidcast_api_queries.md). ## Data Sources and Signals @@ -131,180 +130,4 @@ dashboard](https://delphi.cmu.edu/covidcast/): ### All Available Sources and Signals Beyond the signals available on the COVIDcast dashboard, numerous other signals are -available through our [data export tool](https://delphi.cmu.edu/covidcast/export/) or directly through the API. - -## Constructing API Queries - -The COVIDcast API is based on HTTP GET queries and returns data in JSON form. -The base URL is `https://api.delphi.cmu.edu/epidata/covidcast/`. - -See [this documentation](README.md) for details on specifying epiweeks, dates, -and lists. - -### Query Parameters - -#### Required - -| Parameter | Description | Type | -| --- | --- | --- | -| `data_source` | name of upstream data source (e.g., `doctor-visits` or `fb-survey`; [see full list](covidcast_signals.md)) | string | -| `signal` | name of signal derived from upstream data (see notes below) | string | -| `time_type` | temporal resolution of the signal (e.g., `day`, `week`; see [date coding details](covidcast_times.md)) | string | -| `geo_type` | spatial resolution of the signal (e.g., `county`, `hrr`, `msa`, `dma`, `state`) | string | -| `time_values` | time unit (e.g., date) over which underlying events happened | `list` of time values (e.g., 20200401) | -| `geo_value` | unique code for each location, depending on `geo_type` (see [geographic coding details](covidcast_geography.md)), or `*` for all | string | - -The current set of signals available for each data source is returned by the -[`covidcast_meta`](covidcast_meta.md) endpoint. - -#### Alternate Required Parameters - -The following parameters help specify multiple source-signal, timetype-timevalue or geotype-geovalue pairs. Use them instead of the usual required parameters. - -| Parameter | Replaces | Format | Description | Example | -| --- | --- | --- | --- | --- | -| `signal` | `data_source`, `signal` | `signal={source}:{signal1},{signal2}` | Specify multiple source-signal pairs, grouped by source | `signal=src1:sig1`, `signal=src1:sig1,sig2`, `signal=src1:*`, `signal=src1:sig1;src2:sig3` | -| `time` | `time_type`, `time_values` | `time={timetype}:{timevalue1},{timevalue2}` | Specify multiple timetype-timevalue pairs, grouped by timetype | `time=day:*`, `time=day:20201201`, `time=day:20201201,20201202`, `time=day:20201201-20201204` | -| `geo` | `geo_type`, `geo_value` | `geo={geotype}:{geovalue1},{geovalue2}` | Specify multiple geotype-geovalue pairs, grouped by geotype | `geo=fips:*`, `geo=fips:04019`, `geo=fips:04019,19143`, `geo=fips:04019;msa:40660`, `geo=fips:*;msa:*` | - -#### Optional - -Estimates for a specific `time_value` and `geo_value` are sometimes updated -after they are first published. Many of our data sources issue corrections or -backfill estimates as data arrives; see the [documentation for each source](covidcast_signals.md) -for details. - -The default API behavior is to return the most recently issued value for each -`time_value` selected. - -We also provide access to previous versions of data using the optional query -parameters below. - -| Parameter | Description | Type | -| --- | --- | --- | -| `as_of` | maximum time unit (e.g., date) when the signal data were published (return most recent for each `time_value`) | time value (e.g., 20200401) | -| `issues` | time unit (e.g., date) when the signal data were published (return all matching records for each `time_value`) | `list` of time values (e.g., 20200401) | -| `lag` | time delta (e.g. days) between when the underlying events happened and when the data were published | integer | - -Use cases: - -* To pretend like you queried the API on June 1, such that the returned results - do not include any updates that became available after June 1, use - `as_of=20200601`. -* To retrieve only data that was published or updated on June 1, and exclude - records whose most recent update occurred earlier than June 1, use - `issues=20200601`. -* To retrieve all data that was published between May 1 and June 1, and exclude - records whose most recent update occurred earlier than May 1, use - `issues=20200501-20200601`. The results will include all matching issues for - each `time_value`, not just the most recent. -* To retrieve only data that was published or updated exactly 3 days after the - underlying events occurred, use `lag=3`. - -You should specify only one of these three parameters in any given query. - -**Note:** Each issue in the versioning system contains only the records added or updated during that time unit; we exclude records whose values -remain the same as a previous issue. If you have a research problem that would -require knowing when we last confirmed an unchanged value, please get in touch. - -### Response - -| Field | Description | Type | -| --- | --- | --- | -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results, 1 per geo/time pair | array of objects | -| `epidata[].source` | selected `data_source` | string | -| `epidata[].signal` | selected `signal` | string | -| `epidata[].geo_type` | selected `geo_type` | string | -| `epidata[].geo_value` | location code, depending on `geo_type` | string | -| `epidata[].time_type` | selected `time_type` | string | -| `epidata[].time_value` | time unit (e.g. date) over which underlying events happened (see [date coding details](covidcast_times.md)) | integer | -| `epidata[].value` | value (statistic) derived from the underlying data source | float | -| `epidata[].stderr` | approximate standard error of the statistic with respect to its sampling distribution, `null` when not applicable | float | -| `epidata[].direction` | trend classifier (+1 -> increasing, 0 -> steady or not determined, -1 -> decreasing) | integer | -| `epidata[].sample_size` | number of "data points" used in computing the statistic, `null` when not applicable | float | -| `epidata[].issue` | time unit (e.g. date) when this statistic was published | integer | -| `epidata[].lag` | time delta (e.g. days) between when the underlying events happened and when this statistic was published | integer | -| `epidata[].missing_value` | an integer code that is zero when the `value` field is present and non-zero when the data is missing (see [missing codes](missing_codes.md)) | integer | -| `epidata[].missing_stderr` | an integer code that is zero when the `stderr` field is present and non-zero when the data is missing (see [missing codes](missing_codes.md)) | integer | -| `epidata[].missing_sample_size` | an integer code that is zero when the `sample_size` field is present and non-zero when the data is missing (see [missing codes](missing_codes.md)) | integer | -| `message` | `success` or error message | string | - -**Note:** `result` code 2, "too many results", means that the number of results -you requested was greater than the API's maximum results limit. Results will be -returned, but not all of the results you requested. API clients should check the -results code and consider breaking up requests for e.g. large time intervals into multiple -API calls. - -### Alternative Response Formats - -In addition to the default EpiData Response format, users can customize the response format using the `format=` parameter. - -#### JSON List Response - -When setting the format parameter to `format=json`, it will return a plain list of the `epidata` response objects without the `result` and `message` wrapper. The status of the query is returned via HTTP status codes. For example, a status code of 200 means the query succeeded, while 400 indicates that the query has a missing, misspelled, or otherwise invalid parameter. For all status codes != 200, the returned JSON includes details about what part of the query couldn't be interpreted. - -#### CSV File Response - -When setting the format parameter to `format=csv`, it will return a CSV file with same columns as the response objects. HTTP status codes are used to communicate success/failure, similar to `format=json`. - -#### JSON New Lines Response - -When setting the format parameter to `format=jsonl`, it will return each row as an JSON file separated by a single new line character `\n`. This format is useful for incremental streaming of the results. Similar to the JSON list response status codes are used. - -### Limit Returned Fields - -The `fields` parameter can be used to limit which fields are included in each returned row. This is useful in web applications to reduce the amount of data transmitted. The `fields` parameter supports two syntaxes: allow and deny. Using allowlist syntax, only the listed fields will be returned. For example, `fields=geo_value,value` will drop all fields from the returned data except for `geo_value` and `value`. To use denylist syntax instead, prefix each field name with a dash (-) to exclude it from the results. For example, `fields=-direction` will include all fields in the returned data except for the `direction` field. - - -## Example URLs - -### Facebook Survey CLI on 2020-04-06 to 2010-04-10 (county 06001) - -https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406-20200410&geo_value=06001 - -or - -https://api.delphi.cmu.edu/epidata/covidcast/?signal=fb-survey:smoothed_cli&time=day:20200406-20200410&geo=county:06001 - -Both of these URLs are equivalent and can be used to get the following result: - -```json -{ - "result": 1, - "epidata": [ - { - "geo_value": "06001", - "time_value": 20200407, - "direction": null, - "value": 1.1293550689064, - "stderr": 0.53185454111042, - "sample_size": 281.0245 - }, - ... - ], - "message": "success" -} -``` - -### Facebook Survey CLI on 2020-04-06 (all counties) - -https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406&geo_value=* - -```json -{ - "result": 1, - "epidata": [ - { - "geo_value": "01000", - "time_value": 20200406, - "direction": null, - "value": 1.1693378, - "stderr": 0.1909232, - "sample_size": 1451.0327 - }, - ... - ], - "message": "success" -} -``` +available through our [data export tool](https://delphi.cmu.edu/covidcast/export/) or directly through the API. \ No newline at end of file diff --git a/docs/api/covidcast_api_queries.md b/docs/api/covidcast_api_queries.md new file mode 100644 index 000000000..6954f210d --- /dev/null +++ b/docs/api/covidcast_api_queries.md @@ -0,0 +1,180 @@ +--- +title: Constructing API Queries +parent: Main Endpoint (COVIDcast) +nav_order: 4 +--- +# Constructing API Queries + +The COVIDcast API is based on HTTP GET queries and returns data in JSON form. +The base URL is `https://api.delphi.cmu.edu/epidata/covidcast/`. + +See [this documentation](README.md) for details on specifying epiweeks, dates, +and lists. + +## Query Parameters + +### Required + +| Parameter | Description | Type | +| --- | --- | --- | +| `data_source` | name of upstream data source (e.g., `doctor-visits` or `fb-survey`; [see full list](covidcast_signals.md)) | string | +| `signal` | name of signal derived from upstream data (see notes below) | string | +| `time_type` | temporal resolution of the signal (e.g., `day`, `week`; see [date coding details](covidcast_times.md)) | string | +| `geo_type` | spatial resolution of the signal (e.g., `county`, `hrr`, `msa`, `dma`, `state`) | string | +| `time_values` | time unit (e.g., date) over which underlying events happened | `list` of time values (e.g., 20200401) | +| `geo_value` | unique code for each location, depending on `geo_type` (see [geographic coding details](covidcast_geography.md)), or `*` for all | string | + +The current set of signals available for each data source is returned by the +[`covidcast_meta`](covidcast_meta.md) endpoint. + +### Alternate Required Parameters + +The following parameters help specify multiple source-signal, timetype-timevalue or geotype-geovalue pairs. Use them instead of the usual required parameters. + +| Parameter | Replaces | Format | Description | Example | +| --- | --- | --- | --- | --- | +| `signal` | `data_source`, `signal` | `signal={source}:{signal1},{signal2}` | Specify multiple source-signal pairs, grouped by source | `signal=src1:sig1`, `signal=src1:sig1,sig2`, `signal=src1:*`, `signal=src1:sig1;src2:sig3` | +| `time` | `time_type`, `time_values` | `time={timetype}:{timevalue1},{timevalue2}` | Specify multiple timetype-timevalue pairs, grouped by timetype | `time=day:*`, `time=day:20201201`, `time=day:20201201,20201202`, `time=day:20201201-20201204` | +| `geo` | `geo_type`, `geo_value` | `geo={geotype}:{geovalue1},{geovalue2}` | Specify multiple geotype-geovalue pairs, grouped by geotype | `geo=fips:*`, `geo=fips:04019`, `geo=fips:04019,19143`, `geo=fips:04019;msa:40660`, `geo=fips:*;msa:*` | + +### Optional + +Estimates for a specific `time_value` and `geo_value` are sometimes updated +after they are first published. Many of our data sources issue corrections or +backfill estimates as data arrives; see the [documentation for each source](covidcast_signals.md) +for details. + +The default API behavior is to return the most recently issued value for each +`time_value` selected. + +We also provide access to previous versions of data using the optional query +parameters below. + +| Parameter | Description | Type | +| --- | --- | --- | +| `as_of` | maximum time unit (e.g., date) when the signal data were published (return most recent for each `time_value`) | time value (e.g., 20200401) | +| `issues` | time unit (e.g., date) when the signal data were published (return all matching records for each `time_value`) | `list` of time values (e.g., 20200401) | +| `lag` | time delta (e.g. days) between when the underlying events happened and when the data were published | integer | + +Use cases: + +* To pretend like you queried the API on June 1, such that the returned results + do not include any updates that became available after June 1, use + `as_of=20200601`. +* To retrieve only data that was published or updated on June 1, and exclude + records whose most recent update occurred earlier than June 1, use + `issues=20200601`. +* To retrieve all data that was published between May 1 and June 1, and exclude + records whose most recent update occurred earlier than May 1, use + `issues=20200501-20200601`. The results will include all matching issues for + each `time_value`, not just the most recent. +* To retrieve only data that was published or updated exactly 3 days after the + underlying events occurred, use `lag=3`. + +You should specify only one of these three parameters in any given query. + +**Note:** Each issue in the versioning system contains only the records added or updated during that time unit; we exclude records whose values +remain the same as a previous issue. If you have a research problem that would +require knowing when we last confirmed an unchanged value, please get in touch. + +## Response + +| Field | Description | Type | +| --- | --- | --- | +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results, 1 per geo/time pair | array of objects | +| `epidata[].source` | selected `data_source` | string | +| `epidata[].signal` | selected `signal` | string | +| `epidata[].geo_type` | selected `geo_type` | string | +| `epidata[].geo_value` | location code, depending on `geo_type` | string | +| `epidata[].time_type` | selected `time_type` | string | +| `epidata[].time_value` | time unit (e.g. date) over which underlying events happened (see [date coding details](covidcast_times.md)) | integer | +| `epidata[].value` | value (statistic) derived from the underlying data source | float | +| `epidata[].stderr` | approximate standard error of the statistic with respect to its sampling distribution, `null` when not applicable | float | +| `epidata[].direction` | trend classifier (+1 -> increasing, 0 -> steady or not determined, -1 -> decreasing) | integer | +| `epidata[].sample_size` | number of "data points" used in computing the statistic, `null` when not applicable | float | +| `epidata[].issue` | time unit (e.g. date) when this statistic was published | integer | +| `epidata[].lag` | time delta (e.g. days) between when the underlying events happened and when this statistic was published | integer | +| `epidata[].missing_value` | an integer code that is zero when the `value` field is present and non-zero when the data is missing (see [missing codes](missing_codes.md)) | integer | +| `epidata[].missing_stderr` | an integer code that is zero when the `stderr` field is present and non-zero when the data is missing (see [missing codes](missing_codes.md)) | integer | +| `epidata[].missing_sample_size` | an integer code that is zero when the `sample_size` field is present and non-zero when the data is missing (see [missing codes](missing_codes.md)) | integer | +| `message` | `success` or error message | string | + +**Note:** `result` code 2, "too many results", means that the number of results +you requested was greater than the API's maximum results limit. Results will be +returned, but not all of the results you requested. API clients should check the +results code and consider breaking up requests for e.g. large time intervals into multiple +API calls. + +## Alternative Response Formats + +In addition to the default EpiData Response format, users can customize the response format using the `format=` parameter. + +### JSON List Response + +When setting the format parameter to `format=json`, it will return a plain list of the `epidata` response objects without the `result` and `message` wrapper. The status of the query is returned via HTTP status codes. For example, a status code of 200 means the query succeeded, while 400 indicates that the query has a missing, misspelled, or otherwise invalid parameter. For all status codes != 200, the returned JSON includes details about what part of the query couldn't be interpreted. + +### CSV File Response + +When setting the format parameter to `format=csv`, it will return a CSV file with same columns as the response objects. HTTP status codes are used to communicate success/failure, similar to `format=json`. + +### JSON New Lines Response + +When setting the format parameter to `format=jsonl`, it will return each row as an JSON file separated by a single new line character `\n`. This format is useful for incremental streaming of the results. Similar to the JSON list response status codes are used. + +## Limit Returned Fields + +The `fields` parameter can be used to limit which fields are included in each returned row. This is useful in web applications to reduce the amount of data transmitted. The `fields` parameter supports two syntaxes: allow and deny. Using allowlist syntax, only the listed fields will be returned. For example, `fields=geo_value,value` will drop all fields from the returned data except for `geo_value` and `value`. To use denylist syntax instead, prefix each field name with a dash (-) to exclude it from the results. For example, `fields=-direction` will include all fields in the returned data except for the `direction` field. + + +# Example URLs + +## Facebook Survey CLI on 2020-04-06 to 2010-04-10 (county 06001) + +https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406-20200410&geo_value=06001 + +or + +https://api.delphi.cmu.edu/epidata/covidcast/?signal=fb-survey:smoothed_cli&time=day:20200406-20200410&geo=county:06001 + +Both of these URLs are equivalent and can be used to get the following result: + +```json +{ + "result": 1, + "epidata": [ + { + "geo_value": "06001", + "time_value": 20200407, + "direction": null, + "value": 1.1293550689064, + "stderr": 0.53185454111042, + "sample_size": 281.0245 + }, + ... + ], + "message": "success" +} +``` + +## Facebook Survey CLI on 2020-04-06 (all counties) + +https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406&geo_value=* + +```json +{ + "result": 1, + "epidata": [ + { + "geo_value": "01000", + "time_value": 20200406, + "direction": null, + "value": 1.1693378, + "stderr": 0.1909232, + "sample_size": 1451.0327 + }, + ... + ], + "message": "success" +} +``` From 1b528422ae94172a1d25379bff9d45dfa26c45ad Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 18 Nov 2025 10:52:56 -0800 Subject: [PATCH 28/64] docs: add missing field to COVIDcast Metadata and clarify Code Samples section --- docs/api/covidcast_meta.md | 51 +++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 28 deletions(-) diff --git a/docs/api/covidcast_meta.md b/docs/api/covidcast_meta.md index fb5221579..d6bd4ec13 100644 --- a/docs/api/covidcast_meta.md +++ b/docs/api/covidcast_meta.md @@ -24,25 +24,26 @@ None required. ### Response -| Field | Description | Type | -|---------------------------|---------------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results, one per name/geo_type pair | array of objects | -| `epidata[].data_source` | data source | string | -| `epidata[].signal` | signal name | string | -| `epidata[].time_type` | temporal resolution of the signal (e.g., `day`, `week`) | string | -| `epidata[].geo_type` | geographic resolution (e.g. `county`, `hrr`, `msa`, `dma`, `state`) | string | -| `epidata[].min_time` | minimum observation time (e.g., 20200406) | integer | -| `epidata[].max_time` | maximum observation time (e.g., 20200413) | integer | -| `epidata[].num_locations` | number of distinct geographic locations with data | integer | -| `epidata[].min_value` | minimum value | float | -| `epidata[].max_value` | maximum value | float | -| `epidata[].mean_value` | mean of value | float | -| `epidata[].stdev_value` | standard deviation of value | float | -| `epidata[].max_issue` | most recent date data was issued (e.g., 20200710) | integer | -| `epidata[].min_lag` | smallest lag from observation to issue, in `time_type` units | integer | -| `epidata[].max_lag` | largest lag from observation to issue, in `time_type` units | integer | -| `message` | `success` or error message | string | +| Field | Description | Type | +|---------------------------|---------------------------------------------------------------------|-------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results, one per name/geo_type pair | array of objects | +| `epidata[].data_source` | data source | string | +| `epidata[].signal` | signal name | string | +| `epidata[].time_type` | temporal resolution of the signal (e.g., `day`, `week`) | string | +| `epidata[].geo_type` | geographic resolution (e.g. `county`, `hrr`, `msa`, `dma`, `state`) | string | +| `epidata[].min_time` | minimum observation time | integer (YYYYMMDD)| +| `epidata[].max_time` | maximum observation time | integer (YYYYMMDD)| +| `epidata[].num_locations` | number of distinct geographic locations with data | integer | +| `epidata[].min_value` | minimum value | float | +| `epidata[].max_value` | maximum value | float | +| `epidata[].mean_value` | mean of value | float | +| `epidata[].stdev_value` | standard deviation of value | float | +| `epidata[].last_update` | most recent date when data was updated | integer (YYYYMMDD)| +| `epidata[].max_issue` | most recent date data was issued | integer (YYYYMMDD)| +| `epidata[].min_lag` | smallest lag from observation to issue, in `time_type` units | integer | +| `epidata[].max_lag` | largest lag from observation to issue, in `time_type` units | integer | +| `message` | `success` or error message | string | ## Example URLs @@ -74,7 +75,9 @@ https://api.delphi.cmu.edu/epidata/covidcast_meta/ ## Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +Python and R users are advised to use the dedicated API client, which provides support to return metadata as a data frame. The Python client includes a `metadata()` method for this purpose, while the R client offers a `covidcast_meta()` function to achieve the same. + +Alternatively, libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). The following samples show how to import the library and fetch Delphi's COVID-19 Surveillance Streams metadata. ### JavaScript (in a web browser) @@ -92,10 +95,6 @@ The following samples show how to import the library and fetch Delphi's COVID-19 ### Python -Python users seeking to use the COVIDcast API to fetch data should instead -consider using the [dedicated API client](covidcast_clients.md), which provides -a `metadata()` method to return metadata as a data frame. - Optionally install the package using pip(env): ````bash pip install delphi-epidata @@ -113,10 +112,6 @@ print(res['result'], res['message'], len(res['epidata'])) ### R -R users seeking to use the COVIDcast API to fetch data should instead consider -using the [dedicated API client](covidcast_clients.md), which provides a -`covidcast_meta()` function to return metadata as a data frame. - ````R # Import source('delphi_epidata.R') From 8591b571d66887d2df65f7f79a47c8503e4a7014 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Fri, 21 Nov 2025 00:16:43 -0800 Subject: [PATCH 29/64] =?UTF-8?q?docs:=20remove=20number=20of=20revisions,?= =?UTF-8?q?=20remove=20date=20of=20last=20change,=20and=20correct=20?= =?UTF-8?q?=E2=80=9Cavailable=20for=E2=80=9D=20and=20"typo=20type".?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../api/covidcast-signals/_source-template.md | 4 +- docs/api/covidcast-signals/chng.md | 7 ++- docs/api/covidcast-signals/covid-act-now.md | 6 +-- .../covid-trends-and-impact-survey.md | 6 +-- docs/api/covidcast-signals/doctor-visits.md | 12 ++---- docs/api/covidcast-signals/dsew-cpr.md | 6 +-- docs/api/covidcast-signals/ght.md | 6 +-- docs/api/covidcast-signals/google-survey.md | 6 +-- docs/api/covidcast-signals/google-symptoms.md | 7 ++- docs/api/covidcast-signals/hhs.md | 6 +-- .../covidcast-signals/hospital-admissions.md | 18 +++++--- .../indicator-combination.md | 11 +++-- docs/api/covidcast-signals/jhu-csse.md | 6 +-- docs/api/covidcast-signals/nchs-mortality.md | 6 +-- docs/api/covidcast-signals/nhsn.md | 43 +++++++++++-------- docs/api/covidcast-signals/nssp.md | 31 +++++++------ docs/api/covidcast-signals/quidel.md | 10 ++--- docs/api/covidcast-signals/safegraph.md | 4 +- docs/api/covidcast-signals/usa-facts.md | 6 +-- docs/api/covidcast-signals/youtube-survey.md | 6 +-- 20 files changed, 97 insertions(+), 110 deletions(-) diff --git a/docs/api/covidcast-signals/_source-template.md b/docs/api/covidcast-signals/_source-template.md index f2e966817..185a6a168 100644 --- a/docs/api/covidcast-signals/_source-template.md +++ b/docs/api/covidcast-signals/_source-template.md @@ -11,8 +11,8 @@ grand_parent: Main Endpoint (COVIDcast) * **Earliest issue available:** DATE RELEASED TO API * **Number of data revisions since 19 May 2020:** 0 * **Date of last change:** Never -* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [LICENSE NAME](../covidcast_licensing.md#APPLICABLE-SECTION) A brief description of what this source measures. diff --git a/docs/api/covidcast-signals/chng.md b/docs/api/covidcast-signals/chng.md index 06b6d5a29..2b36a1381 100644 --- a/docs/api/covidcast-signals/chng.md +++ b/docs/api/covidcast-signals/chng.md @@ -10,13 +10,12 @@ nav_order: 1 * **Source name:** `chng` * **Earliest issue available:** November 4, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never -* **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) ## Overview +{: .no_toc} **Notice: This data source was inactive between 2021-10-04 and 2021-12-02 to allow us resolve some problems with the data pipeline. We have resumed daily updates and are working on a data patch to fill the gap. [Additional details on this inactive period are available below](#pipeline-pause).** diff --git a/docs/api/covidcast-signals/covid-act-now.md b/docs/api/covidcast-signals/covid-act-now.md index 41a5cabc2..b0ae0738b 100644 --- a/docs/api/covidcast-signals/covid-act-now.md +++ b/docs/api/covidcast-signals/covid-act-now.md @@ -10,10 +10,8 @@ nav_order: 2 * **Source name:** `covid-act-now` * **Earliest issue available:** 2021-03-25 -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never -* **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) The [COVID Act Now (CAN)](https://covidactnow.org/) data source provides COVID-19 testing statistics, such as positivity rates and total tests performed. diff --git a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md index 147566f98..a3c8eab5a 100644 --- a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -11,10 +11,8 @@ permalink: api/covidcast-signals/fb-survey.html * **Source name:** `fb-survey` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** [June 3, 2020](../covidcast_changelog.md#fb-survey) -* **Available for:** county, hrr, msa, state, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) ## Overview diff --git a/docs/api/covidcast-signals/doctor-visits.md b/docs/api/covidcast-signals/doctor-visits.md index 5eb9c96a9..bdad5a632 100644 --- a/docs/api/covidcast-signals/doctor-visits.md +++ b/docs/api/covidcast-signals/doctor-visits.md @@ -10,14 +10,13 @@ nav_order: 1 * **Source name:** `doctor-visits` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** November 9, 2020 -* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) ## Overview +{: .no_toc} This data source is based on information about outpatient visits, provided to us by health system partners. Using this outpatient data, we estimate the @@ -50,15 +49,12 @@ $$ Y_{it}^{\text{Flu}}\right)}{N_{it}} $$ -The estimated standard error is: +**Note on Uncertainty:** The standard error formula below represents the theoretical error of the binomial proportion. However, due to the smoothing and day-of-week adjustments applied later in the pipeline, the actual standard error in the final signal will differ. $$ \widehat{\text{se}}(\hat{p}_{it}) = 100 \sqrt{\frac{\frac{\hat{p}_{it}}{100}(1-\frac{\hat{p}_{it}}{100})}{N_{it}}}. $$ -Note the quantity above is not going to be correct for multiple reasons: smoothing/day of -week adjustments/etc. - ### Day-of-Week Adjustment The fraction of visits due to CLI is dependent on the day of the week. On diff --git a/docs/api/covidcast-signals/dsew-cpr.md b/docs/api/covidcast-signals/dsew-cpr.md index 82e76d7df..05ab5bdd7 100644 --- a/docs/api/covidcast-signals/dsew-cpr.md +++ b/docs/api/covidcast-signals/dsew-cpr.md @@ -10,10 +10,8 @@ nav_order: 2 * **Source name:** `dsew-cpr` * **Earliest issue available:** 2022-01-28 -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never -* **Available for:** county, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) The Community Profile Report (CPR) is published by the Data Strategy and Execution Workgroup (DSEW) of the White House COVID-19 Team. For more information, see the [official description at healthdata.gov](https://healthdata.gov/Health/COVID-19-Community-Profile-Report/gqxm-d9w9) for "COVID-19 Community Profile Report". Each issue of the CPR is made available as an attachment on that page. You can view all attachments by scrolling to the bottom of the "About this dataset" panel and clicking "Show more". diff --git a/docs/api/covidcast-signals/ght.md b/docs/api/covidcast-signals/ght.md index 9b592f60e..52181290c 100644 --- a/docs/api/covidcast-signals/ght.md +++ b/docs/api/covidcast-signals/ght.md @@ -10,10 +10,8 @@ nav_order: 2 * **Source name:** `ght` * **Earliest issue available:** April 29, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never -* **Available for:** dma, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** dma, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) ## Overview diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md index 27ef423dc..10a1f0bf4 100644 --- a/docs/api/covidcast-signals/google-survey.md +++ b/docs/api/covidcast-signals/google-survey.md @@ -10,10 +10,8 @@ nav_order: 2 * **Source name:** `google-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never -* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) ## Overview diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index f37926242..a78c042ca 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -10,13 +10,12 @@ nav_order: 1 * **Source name:** `google-symptoms` * **Earliest issue available:** Aug 20, 2017 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** February 28, 2025 -* **Available for:** county, MSA, HRR, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, MSA, HRR, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** To download or use the data, you must agree to the Google [Terms of Service](https://policies.google.com/terms) ## Overview +{: .no_toc} This data source is based on the [COVID-19 Search Trends symptoms dataset](https://console.cloud.google.com/marketplace/product/bigquery-public-datasets/covid19-search-trends?hl=en-GB). diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index d591aa720..287a7a124 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -10,10 +10,8 @@ nav_order: 2 * **Source name:** `hhs` * **Earliest issue available:** November 16, 2020 -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never -* **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) The U.S. Department of Health & Human Services (HHS) publishes several diff --git a/docs/api/covidcast-signals/hospital-admissions.md b/docs/api/covidcast-signals/hospital-admissions.md index 1dcd5959f..b1a0f116d 100644 --- a/docs/api/covidcast-signals/hospital-admissions.md +++ b/docs/api/covidcast-signals/hospital-admissions.md @@ -10,13 +10,12 @@ nav_order: 1 * **Source name:** `hospital-admissions` * **Earliest issue available:** June 21, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** October 20, 2020 -* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) ## Overview +{: .no_toc} This data source is based on electronic medical records and claims data about hospital admissions, provided to us by health system partners. We use this @@ -26,12 +25,19 @@ COVID-associated diagnosis code in a given location, on a given day. See also our [Health & Human Services](hhs.md) data source for official COVID hospitalization reporting from the Department of Health & Human Services. +**Active Signals.** These signals are currently updated. + | Signal | Description | | --- | --- | | `smoothed_covid19_from_claims` | Estimated percentage of new hospital admissions with COVID-associated diagnoses, based on claims data from health system partners, smoothed in time using a Gaussian linear smoother
**Earliest date available:** 2020-02-01 | | `smoothed_adj_covid19_from_claims` | Same as `smoothed_covid19_from_claims`, but with systematic day-of-week effects removed using [the same mechanism as in `doctor-visits`](doctor-visits.md#day-of-week-adjustment)
**Earliest date available:** 2020-02-01 | -| `smoothed_covid19` | Estimated percentage of new hospital admissions with COVID-associated diagnoses, based on electronic medical record and claims data from health system partners, smoothed in time using a Gaussian linear smoother. _This signal is no longer updated as of 1 October, 2020._
**Earliest date available:** 2020-02-01 | -| `smoothed_adj_covid19` | Same as `smoothed_covid19`, but with systematic day-of-week effects removed using [the same mechanism as in `doctor-visits`](doctor-visits.md#day-of-week-adjustment). _This signal is no longer updated as of 1 October, 2020._
**Earliest date available:** 2020-02-01 | + +**Deprecated Signals.** These signals are frozen and no longer updated as of Oct 1, 2020. + +| Signal | Description | +| --- | --- | +| `smoothed_covid19` | Estimated percentage of new hospital admissions with COVID-associated diagnoses, based on electronic medical record and claims data from health system partners, smoothed in time using a Gaussian linear smoother.
**Earliest date available:** 2020-02-01 | +| `smoothed_adj_covid19` | Same as `smoothed_covid19`, but with systematic day-of-week effects removed using [the same mechanism as in `doctor-visits`](doctor-visits.md#day-of-week-adjustment).
**Earliest date available:** 2020-02-01 | ## Table of Contents {: .no_toc .text-delta} diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index fe2edd3cf..135f60e71 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -22,10 +22,9 @@ calculated or composed by Delphi. It is not a primary data source. ## Statistical Combination Signals * **Earliest issue available:** May 20, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** [June 3, 2020](../covidcast_changelog.md#indicator-combination) -* **Available for:** county, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +(../covidcast_changelog.md#indicator-combination) +* **Geography type available:** county, msa, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) These signals combine Delphi's indicators---*not* including cases and deaths, @@ -194,8 +193,8 @@ The resampling method for each input source is as follows: * **Earliest issue available:** 7 July 2020 * **Number of data revisions since 19 May 2020:** 1 * **Date of last change:** [12 October 2020](../covidcast_changelog.md#indicator-combination) -* **Available for:** county, msa, hrr, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, msa, hrr, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) These signals combine the cases and deaths data from JHU and USA Facts. This is a straight composition: the signals below use the [JHU signal data](jhu-csse.md) diff --git a/docs/api/covidcast-signals/jhu-csse.md b/docs/api/covidcast-signals/jhu-csse.md index c9d665b5a..622d26397 100644 --- a/docs/api/covidcast-signals/jhu-csse.md +++ b/docs/api/covidcast-signals/jhu-csse.md @@ -10,10 +10,8 @@ nav_order: 2 * **Source name:** `jhu-csse` * **Earliest issue available:** May 7, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** [October 7, 2020](../covidcast_changelog.md#jhu-csse) -* **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](#source-and-licensing) ## Overview diff --git a/docs/api/covidcast-signals/nchs-mortality.md b/docs/api/covidcast-signals/nchs-mortality.md index 94a72ead2..f7d9eae15 100644 --- a/docs/api/covidcast-signals/nchs-mortality.md +++ b/docs/api/covidcast-signals/nchs-mortality.md @@ -10,10 +10,8 @@ nav_order: 1 * **Source name:** `nchs-mortality` * **Earliest issue available:** Epiweek 50 2020 (6-12 December 2020) -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never -* **Available for:** state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** week (see [date format docs](../covidcast_times.md)) +* **Geography type available:** state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** week (see [date format docs](../covidcast_times.md)) * **License:** [NCHS Data Use Agreement](https://www.cdc.gov/nchs/data_access/restrictions.htm) This data source of national provisional death counts is based on death diff --git a/docs/api/covidcast-signals/nhsn.md b/docs/api/covidcast-signals/nhsn.md index 2fc89afd7..c16e3ce13 100644 --- a/docs/api/covidcast-signals/nhsn.md +++ b/docs/api/covidcast-signals/nhsn.md @@ -9,13 +9,12 @@ nav_order: 1 * **Source name:** `nhsn` * **Earliest issue available:** November 19, 2024 -* **Number of data revisions since 18 Nov 2024:** 0 -* **Date of last change:** Never -* **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** week (see [date format docs](../covidcast_times.md)) +* **Geography type available:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** week (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) ## Overview +{: .no_toc} [The National Healthcare Safety Network (NHSN)](https://www.cdc.gov/nhsn/index.html) is the nation’s most widely used healthcare-associated infection tracking system. This dataset reports preliminary and finalized weekly hospital respiratory data and metrics aggregated to national and state/territory levels reported to the CDC’s National Health Safety Network (NHSN). Values are available for reference dates beginning August 2020. @@ -30,21 +29,29 @@ For reference dates in May 2024, NHSN received data from 78% of US EDs. State and nation-level values are pulled directly from the source; HHS-level values are aggregated up from the state level. +### Available Signals +{: .no_toc} -| Signal | Description | -|------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `confirmed_admissions_covid_ew` | Total number of patients hospitalized with confirmed COVID-19 over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
**Earliest date available:** 2020-08-08 | -| `hosprep_confirmed_admissions_covid_ew` | Total number of number of hospitals reporting new admissions with confirmed COVID-19 over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
**Earliest date available:** 2020-08-08 | -| `confirmed_admissions_covid_ew_prelim` | Total number of patients hospitalized with confirmed COVID-19 over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
**Earliest date available:** 2020-08-08 | -| `hosprep_confirmed_admissions_covid_ew_prelim` | Total number of number of hospitals reporting new admissions with confirmed COVID-19 over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
**Earliest date available:** 2020-08-08 | -| `confirmed_admissions_flu_ew` | Total number of patients hospitalized with confirmed influenza over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
**Earliest date available:** 2020-08-08 | -| `hosprep_confirmed_admissions_flu_ew` | Total number of hospitals reporting new admissions with confirmed influenza over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
**Earliest date available:** 2020-08-08 | -| `confirmed_admissions_flu_ew_prelim` | Total number of patients hospitalized with confirmed influenza over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
**Earliest date available:** 2020-08-08 | -| `hosprep_confirmed_admissions_flu_ew_prelim` | Total number of number of hospitals reporting new admissions with confirmed influenza over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
**Earliest date available:** 2020-08-08 | -| `confirmed_admissions_rsv_ew` | Total number of patients hospitalized with confirmed RSV over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
**Earliest date available:** 2020-08-08 | -| `hosprep_confirmed_admissions_rsv_ew` | Total number of number of hospitals reporting new admissions with confirmed RSV over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Friday or Saturday of the following week.
**Earliest date available:** 2020-08-08 | -| `confirmed_admissions_rsv_ew_prelim` | Total number of patients hospitalized with confirmed RSV over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
**Earliest date available:** 2020-08-08 | -| `hosprep_confirmed_admissions_rsv_ew_prelim` | Total number of number of hospitals reporting new admissions with confirmed RSV over the entire week (Sunday-Saturday). Only includes hospitalizations whose report was received before the Wednesday of the following week.
**Earliest date available:** 2020-08-08 | +* **Earliest date available:** August 8, 2020 +* **Time:** Week (Sunday to Saturday) +* **Reporting Cutoffs:** + * **Finalized Signals:** Data received by Friday/Saturday of the following week (~6-7 day lag). + * **Preliminary (`_prelim`) Signals:** Data received by Wednesday of the following week (~4 day lag). + +| Signal Name | Pathogen | Metric Description | Version | +| :--- | :--- | :--- | :--- | +| `confirmed_admissions_covid_ew` | COVID-19 | **Patient Count:** Total hospitalized patients. | Finalized | +| `confirmed_admissions_covid_ew_prelim` | COVID-19 | **Patient Count:** Total hospitalized patients. | Preliminary | +| `hosprep_confirmed_admissions_covid_ew` | COVID-19 | **Facility Count:** Number of hospitals reporting admissions. | Finalized | +| `hosprep_confirmed_admissions_covid_ew_prelim` | COVID-19 | **Facility Count:** Number of hospitals reporting admissions. | Preliminary | +| `confirmed_admissions_flu_ew` | Influenza | **Patient Count:** Total hospitalized patients. | Finalized | +| `confirmed_admissions_flu_ew_prelim` | Influenza | **Patient Count:** Total hospitalized patients. | Preliminary | +| `hosprep_confirmed_admissions_flu_ew` | Influenza | **Facility Count:** Number of hospitals reporting admissions. | Finalized | +| `hosprep_confirmed_admissions_flu_ew_prelim` | Influenza | **Facility Count:** Number of hospitals reporting admissions. | Preliminary | +| `confirmed_admissions_rsv_ew` | RSV | **Patient Count:** Total hospitalized patients. | Finalized | +| `confirmed_admissions_rsv_ew_prelim` | RSV | **Patient Count:** Total hospitalized patients. | Preliminary | +| `hosprep_confirmed_admissions_rsv_ew` | RSV | **Facility Count:** Number of hospitals reporting admissions. | Finalized | +| `hosprep_confirmed_admissions_rsv_ew_prelim` | RSV | **Facility Count:** Number of hospitals reporting admissions. | Preliminary | ## Table of Contents diff --git a/docs/api/covidcast-signals/nssp.md b/docs/api/covidcast-signals/nssp.md index 8e988a25b..80cb59e3e 100644 --- a/docs/api/covidcast-signals/nssp.md +++ b/docs/api/covidcast-signals/nssp.md @@ -9,29 +9,32 @@ nav_order: 1 * **Source name:** `nssp` * **Earliest issue available:** April 17, 2024 -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never -* **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** week (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** week (see [date format docs](../covidcast_times.md)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) ## Overview +{: .no_toc} [The National Syndromic Surveillance Program (NSSP)](https://www.cdc.gov/nssp/php/about/index.html) is an effort to track epidemiologically relevant conditions. This dataset in particular tracks emergency department (ED) visits arising from a subset of influenza-like illnesses, specifically influenza, COVID-19, and respiratory syncytial virus (RSV). It is derived from the CDC's [Respiratory Virus Response NSSP Emergency Department Visit Trajectories dataset](https://data.cdc.gov/Public-Health-Surveillance/2023-Respiratory-Virus-Response-NSSP-Emergency-Dep/rdmq-nq56/about_data), which started reporting data in late 2022. As of May 2024, NSSP received data from 78% of US EDs. -| Signal | Description | -|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------| -| `pct_ed_visits_covid` | Percent of ED visits that had a discharge diagnosis code of COVID-19
**Earliest date available:** 2022-10-01 | -| `pct_ed_visits_influenza` | Percent of ED visits that had a discharge diagnosis code of influenza
**Earliest date available:** 2022-10-01 | -| `pct_ed_visits_rsv` | Percent of ED visits that had a discharge diagnosis code of rsv
**Earliest date available:** 2022-10-01 | -| `pct_ed_visits_combined` | Percent of ED visits that had a discharge diagnosis code of COVID-19, influenza, or rsv
**Earliest date available:** 2022-10-01 | -| `smoothed_pct_ed_visits_covid` | 3 week moving average of `pct_ed_visits_covid`
**Earliest date available:** 2022-10-01 | -| `smoothed_pct_ed_visits_influenza` | 3 week moving average of `pct_ed_visits_influenza`
**Earliest date available:** 2022-10-01 | -| `smoothed_pct_ed_visits_rsv` | 3 week moving average of `pct_ed_visits_rsv`
**Earliest date available:** 2022-10-01 | -| `smoothed_pct_ed_visits_combined` | 3 week moving average of `pct_ed_visits_combined`
**Earliest date available:** 2022-10-01 | + +### Available Signals +{: .no_toc} + +* **Earliest date available:** August 8, 2020 +* **Raw Signals** (`pct_ed_visits_...`) represent the weekly percentage of ED visits for the specific pathogen. +* **Smoothed Signals** (`smoothed_pct_ed_visits_...`) represent a **3-week moving average** of the raw signal. + +| Signal Pair (Raw / Smoothed) | Pathogen | Description | +| :--- | :--- | :--- | +| `pct_ed_visits_covid`
`smoothed_pct_ed_visits_covid` | **COVID-19** | Percentage of ED visits with a discharge diagnosis of COVID-19. | +| `pct_ed_visits_influenza`
`smoothed_pct_ed_visits_influenza` | **Influenza** | Percentage of ED visits with a discharge diagnosis of Influenza. | +| `pct_ed_visits_rsv`
`smoothed_pct_ed_visits_rsv` | **RSV** | Percentage of ED visits with a discharge diagnosis of RSV. | +| `pct_ed_visits_combined`
`smoothed_pct_ed_visits_combined` | **Combined** | Percentage of ED visits with a diagnosis of **any** of the above (COVID, Flu, or RSV). | | ## Table of Contents {: .no_toc .text-delta} diff --git a/docs/api/covidcast-signals/quidel.md b/docs/api/covidcast-signals/quidel.md index 430339291..006d71b05 100644 --- a/docs/api/covidcast-signals/quidel.md +++ b/docs/api/covidcast-signals/quidel.md @@ -20,10 +20,8 @@ nav_order: 1 * **Source name:** `quidel` * **Earliest issue available:** July 29, 2020 -* **Number of data revisions since May 19, 2020:** 1 -* **Date of last change:** October 22, 2020 -* **Available for:** county, hrr, msa, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) ### Overview @@ -170,8 +168,8 @@ These signals are inactive. They were updated until May 19, 2020. * **Last issued:** May 19, 2020 * **Number of data revisions since May 19, 2020:** 0 * **Date of last change:** Never -* **Available for:** msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** msa, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) ### Overview diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index 96775de0f..5b8e2f909 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -8,8 +8,8 @@ nav_order: 2 # SafeGraph {: .no_toc} * **Source name:** `safegraph` -* **Available for:** county, MSA, HRR, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, MSA, HRR, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) This data source uses data reported by [SafeGraph](https://www.safegraph.com/) diff --git a/docs/api/covidcast-signals/usa-facts.md b/docs/api/covidcast-signals/usa-facts.md index 3c972cfcd..fb55a4305 100644 --- a/docs/api/covidcast-signals/usa-facts.md +++ b/docs/api/covidcast-signals/usa-facts.md @@ -10,10 +10,8 @@ nav_order: 2 * **Source name:** `usa-facts` * **Earliest issue available:** June 24, 2020 -* **Number of data revisions since May 19, 2020:** 2 -* **Date of last change:** [November 3, 2020](../covidcast_changelog.md#usa-facts) -* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](#source-and-licensing) This data source of confirmed COVID-19 cases and deaths is based on reports made diff --git a/docs/api/covidcast-signals/youtube-survey.md b/docs/api/covidcast-signals/youtube-survey.md index 5b376f913..e23bf67f7 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -12,10 +12,8 @@ nav_order: 2 * **Source name:** `youtube-survey` * **Earliest issue available:** May 01, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never -* **Available for:** state (see [geography coding docs](../covidcast_geography.md)) -* **Time type:** day (see [date format docs](../covidcast_times.md)) +* **Geography type available:** state (see [geography coding docs](../covidcast_geography.md)) +* **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) ## Overview From 430ce6b8656a44a1a7f8eb6bceb5d97d2c7fc8c4 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Fri, 21 Nov 2025 00:29:49 -0800 Subject: [PATCH 30/64] docs: remove number of revisions and date of last change on header --- docs/api/covidcast-signals/_source-template.md | 2 -- docs/api/covidcast-signals/indicator-combination.md | 1 - 2 files changed, 3 deletions(-) diff --git a/docs/api/covidcast-signals/_source-template.md b/docs/api/covidcast-signals/_source-template.md index 185a6a168..4472ff66a 100644 --- a/docs/api/covidcast-signals/_source-template.md +++ b/docs/api/covidcast-signals/_source-template.md @@ -9,8 +9,6 @@ grand_parent: Main Endpoint (COVIDcast) * **Source name:** `SOURCE-API-NAME` * **Earliest issue available:** DATE RELEASED TO API -* **Number of data revisions since 19 May 2020:** 0 -* **Date of last change:** Never * **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [LICENSE NAME](../covidcast_licensing.md#APPLICABLE-SECTION) diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index 135f60e71..cfcaeb79f 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -22,7 +22,6 @@ calculated or composed by Delphi. It is not a primary data source. ## Statistical Combination Signals * **Earliest issue available:** May 20, 2020 -(../covidcast_changelog.md#indicator-combination) * **Geography type available:** county, msa, state (see [geography coding docs](../covidcast_geography.md)) * **Time type available:** day (see [date format docs](../covidcast_times.md)) * **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) From e4e39583e5d2486ba51389013ef87de0ef8c79c1 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Fri, 21 Nov 2025 15:56:11 -0800 Subject: [PATCH 31/64] docs: update header with general information and add code samples with updated clients. --- docs/api/client_libraries.md | 5 +- docs/api/covid_hosp.md | 74 ++++++++--- docs/api/covid_hosp_facility.md | 79 ++++++++--- docs/api/covid_hosp_facility_lookup.md | 77 ++++++++--- docs/api/delphi.md | 97 +++++++++++++- docs/api/dengue_digital_surveillance.md | 136 +++++++++++++++++-- docs/api/dengue_nowcast.md | 137 +++++++++++++++++-- docs/api/digital_surveillance_sensors.md | 85 ++++++++---- docs/api/ecdc_ili.md | 159 ++++++++++++++++++++--- docs/api/flusurv.md | 96 ++++++++++---- docs/api/fluview.md | 129 +++++++++++------- docs/api/fluview_clinical.md | 124 ++++++++++++------ docs/api/gft.md | 108 ++++++++++----- docs/api/ght.md | 126 ++++++++++++++++-- 14 files changed, 1144 insertions(+), 288 deletions(-) diff --git a/docs/api/client_libraries.md b/docs/api/client_libraries.md index ef825a156..d97216fb3 100644 --- a/docs/api/client_libraries.md +++ b/docs/api/client_libraries.md @@ -1,7 +1,6 @@ --- title: API Clients -parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 1 +nav_order: 6 --- # Epidata API Clients @@ -30,7 +29,7 @@ with `install.packages("epidatr")`. library(epidatr) data <- pub_covidcast('fb-survey', 'smoothed_cli', 'county', 'day', geo_values = '06001', time_values = c(20200401, 20200405:20200414)) -cat(data) +print(data) ``` ### Python diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md index 372402e5b..584054da3 100644 --- a/docs/api/covid_hosp.md +++ b/docs/api/covid_hosp.md @@ -6,12 +6,19 @@ nav_order: 2 --- # COVID-19 Hospitalization by State +{: .no_toc} -This data source is a mirror of the "COVID-19 Reported Patient Impact and -Hospital Capacity by State Timeseries" and "COVID-19 Reported Patient Impact and -Hospital Capacity by State" datasets provided by the US Department of -Health & Human Services via healthdata.gov. The latter provides more frequent updates, -so it is combined with the former to create a single dataset which is as recent as possible. +* **Source name:** `covid_hosp_state_timeseries` +* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) +* **Earliest issue available:** 2020-01-01 +* **Temporal Resolution:** Daily +* **Spatial Resolution:** US States plus DC, PR, and VI +* **License:** [Public Domain US Government](https://www.usa.gov/government-works) + +## Overview +{: .no_toc} + +This data source provides various measures of COVID-19 burden on patients and healthcare facilities in the US. It is a mirror of the "COVID-19 Reported Patient Impact and Hospital Capacity by State Timeseries" and "COVID-19 Reported Patient Impact and Hospital Capacity by State" datasets provided by HHS via healthdata.gov. The latter provides more frequent updates, so it is combined with the former to create a single dataset which is as recent as possible. HHS performs up to four days of forward-fill for missing values in the [facility-level data](covid_hosp_facility.md) which are aggregated to make this @@ -34,17 +41,11 @@ General topics not specific to any particular data source are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing) and [citing](README.md#citing). -## Metadata +## Table of contents +{: .no_toc .text-delta} -This data source provides various measures of COVID-19 burden on patients and healthcare in the US. -- Data source: US Department of Health & Human Services (HHS) [COVID-19 Reported Patient Impact and -Hospital Capacity by State Timeseries](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) (published weekly) - and [COVID-19 Reported Patient Impact and Hospital Capacity by State](https://healthdata.gov/dataset/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/6xf2-c3ie) (published on an irregular schedule, every 1-6 days) -- Temporal Resolution: Daily, starting 2020-01-01 -- Spatial Resolution: US States plus DC, PR, and VI -- Open Access: [Public Domain US Government](https://www.usa.gov/government-works) -- Versioned by Delphi according to "issue" date, which is the date that the -dataset was published by HHS. +1. TOC +{:toc} # The API @@ -218,12 +219,53 @@ https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates= # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following sample shows how to import the library and fetch MA on 2020-05-10 (per most recent issue). +### R + +```R +library(epidatr) +# Fetch data +res <- pub_covid_hosp_state_timeseries(states = "MA", dates = 20200510) +print(res) +``` + ### Python +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_covid_hosp(states="MA", dates=20200510) +print(res) +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$covid_hosp(states = list("MA"), dates = list(20200510)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + Optionally install the package using pip(env): ```bash pip install delphi-epidata diff --git a/docs/api/covid_hosp_facility.md b/docs/api/covid_hosp_facility.md index 3cca8b20a..d3ca9c5d1 100644 --- a/docs/api/covid_hosp_facility.md +++ b/docs/api/covid_hosp_facility.md @@ -6,10 +6,19 @@ nav_order: 2 --- # COVID-19 Hospitalization by Facility +{: .no_toc} -This data source is a mirror of the "COVID-19 Reported Patient Impact and -Hospital Capacity by Facility" dataset provided by the US Department of Health -& Human Services via healthdata.gov. +* **Source name:** `covid_hosp_facility` +* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) +* **Earliest issue available:** 2020-07-31 +* **Geographic resolution:** healthcare facility (address, city, zip, fips) +* **Temporal resolution:** weekly (Friday -- Thursday) +* **License:** [Public Domain US Government](https://www.usa.gov/government-works) + +## Overview +{: .no_toc} + +This data source provides various measures of COVID-19 burden on patients and healthcare facilities in the US. It is a mirror of the "COVID-19 Reported Patient Impact and Hospital Capacity by Facility" dataset provided by HHS via healthdata.gov. HHS performs up to four days of forward-fill for missing values. @@ -26,16 +35,11 @@ General topics not specific to any particular data source are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing) and [citing](README.md#citing). -## Metadata +## Table of contents +{: .no_toc .text-delta} -This data source provides various measures of COVID-19 burden on patients and healthcare in the US. -- Data source: [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) (HHS) -- Geographic resolution: healthcare facility (address, city, zip, fips) -- Temporal resolution: weekly (Friday -- Thursday) -- First week: 2020-07-31 -- Open Access: [Public Domain US Government](https://www.usa.gov/government-works) -- Versioned by Delphi according to the date that the dataset was published by -HHS. New versions are expected to be published roughly weekly. +1. TOC +{:toc} # The API @@ -199,24 +203,65 @@ https://api.delphi.cmu.edu/epidata/covid_hosp_facility/?hospital_pks=390119&coll # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following sample shows how to import the library and fetch Moses Taylor Hospital (Scranton, PA) on the first collection week of December 2020 (per most recent issue). +### R + +```R +library(epidatr) +# Fetch data +res <- pub_covid_hosp_facility(hospital_pks = "390119", collection_weeks = epirange(20201201, 20201207)) +print(res) +``` + ### Python +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_covid_hosp_facility(hospital_pks="390119", collection_weeks=EpiRange(20201201, 20201207)) +print(res) +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$covid_hosp_facility(hospital_pks = list("390119"), collection_weeks = list(Epidata$range(20201201, 20201207))) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data res = Epidata.covid_hosp_facility('390119', Epidata.range(20201201, 20201207)) print(res['result'], res['message'], len(res['epidata'])) -```` +``` diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md index 98356d0cd..d15b9273f 100644 --- a/docs/api/covid_hosp_facility_lookup.md +++ b/docs/api/covid_hosp_facility_lookup.md @@ -6,14 +6,19 @@ nav_order: 2 --- # COVID-19 Hospitalization: Facility Lookup +{: .no_toc} -This endpoint is a companion to the -[`covid_hosp_facility` endpoint](covid_hosp_facility.md). It provides a way to -find unique identifiers and other metadata for facilities of interest. +* **Source name:** `covid_hosp_facility_lookup` +* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) +* **Total facilities:** 4922 +* **License:** [Public Domain US Government](https://www.usa.gov/government-works) -Metadata is derived from the "COVID-19 Reported Patient Impact and Hospital -Capacity by Facility" dataset provided by the US Department of Health & Human -Services via healthdata.gov. +## Overview +{: .no_toc} + +This endpoint is a companion to the [`covid_hosp_facility` endpoint](covid_hosp_facility.md). It provides a way to find unique identifiers and other metadata for facilities of interest. + +Metadata is derived from the "COVID-19 Reported Patient Impact and Hospital Capacity by Facility" dataset provided by HHS via healthdata.gov. See the [official description and data dictionary at healthdata.gov](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) @@ -23,12 +28,11 @@ General topics not specific to any particular data source are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing) and [citing](README.md#citing). -## Metadata +## Table of contents +{: .no_toc .text-delta} -This data source provides metadata about healthcare facilities in the US. -- Data source: [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) (HHS) -- Total number of facilities: 4922 -- Open Access: [Public Domain US Government](https://www.usa.gov/government-works) +1. TOC +{:toc} # The API @@ -112,23 +116,64 @@ https://api.delphi.cmu.edu/epidata/covid_hosp_facility_lookup/?city=southlake # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following sample shows how to import the library and fetch facilities in the city of Southlake (TX). +### R + +```R +library(epidatr) +# Fetch data +res <- pub_covid_hosp_facility_lookup(city = "southlake") +print(res) +``` + ### Python +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_covid_hosp_facility_lookup(city="southlake") +print(res) +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$covid_hosp_facility_lookup(city = "southlake") +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data res = Epidata.covid_hosp_facility_lookup(city='southlake') print(res['result'], res['message'], len(res['epidata'])) -```` +``` diff --git a/docs/api/delphi.md b/docs/api/delphi.md index dae9c672b..e41346f37 100644 --- a/docs/api/delphi.md +++ b/docs/api/delphi.md @@ -6,18 +6,28 @@ nav_order: 2 --- # Delphi Forecasts +{: .no_toc} -This is the documentation of the API for accessing the Delphi Forecast (`delphi`) endpoint of -the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. +* **Source name:** `delphi` +* **Earliest issue available:** 2010w01 +* **Time type available:** epiweek +* **License:** [CC BY](https://creativecommons.org/licenses/by/4.0/) + +## Overview +{: .no_toc} + +This data source provides access to experimental and retrospective Delphi forecasting systems and nowcasting outputs. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Delphi Forecast Data +## Table of contents +{: .no_toc .text-delta} -... +1. TOC +{:toc} # The API @@ -59,8 +69,8 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs -### Delphi on 2020w01 (EC) -https://api.delphi.cmu.edu/epidata/delphi/?system=ec&epiweek=202001 +### Delphi on 2015w01 (EC) +https://api.delphi.cmu.edu/epidata/delphi/?system=ec&epiweek=201501 ```json { @@ -142,4 +152,77 @@ https://api.delphi.cmu.edu/epidata/delphi/?system=ec&epiweek=202001 # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch Delphi Forecast data for system `ec` on epiweek `201501`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_delphi(system = 'ec', epiweek = 201501) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.delphi('ec', 201501) +print(res['result'], res['message'], len(res['epidata'])) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$delphi(system = 'ec', epiweek = 201501) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` +Place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.delphi('ec', 201501) +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/dengue_digital_surveillance.md b/docs/api/dengue_digital_surveillance.md index 9351e7dff..cd0458f99 100644 --- a/docs/api/dengue_digital_surveillance.md +++ b/docs/api/dengue_digital_surveillance.md @@ -7,19 +7,30 @@ permalink: api/dengue_sensors.html --- # Dengue Digital Surveillance Sensors +{: .no_toc} -This is the API documentation for accessing the Dengue Digital Surveillance -Sensors (`dengue_sensors`) endpoint of [Delphi](https://delphi.cmu.edu/)'s -epidemiological data. +* **Source name:** `dengue_sensors` +* **Earliest issue available:** 2003w01 + +* **Time type available:** epiweek +* **License:** [CC BY](https://creativecommons.org/licenses/by/4.0/) + + +## Overview +{: .no_toc} + +This endpoint provides digital surveillance sensor estimates for dengue activity, derived from various data streams. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Delphi's Dengue Digital Surveillance Sensors Data +## Table of contents +{: .no_toc .text-delta} -... +1. TOC +{:toc} # The API @@ -31,21 +42,118 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required - +| Parameter | Description | Type | +| --- | --- | --- | +| `auth` | password | string | +| `epiweeks` | epiweeks | `list` of epiweeks | +| `locations` | locations | `list` of location labels | + + ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|-----------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].location` | location label | string | +| `epidata[].epiweek` | epiweek | integer | +| `epidata[].name` | name | string | +| `epidata[].value` | value | float | +| `message` | `success` or error message | string | # Example URLs - +### Dengue Sensors on 2015w01 (Puerto Rico) +https://api.delphi.cmu.edu/epidata/dengue_sensors/?auth=...&locations=pr&epiweeks=201501&names=ght + +```json +{ + "result": 1, + "epidata": [ + { + "location": "pr", + "epiweek": 201501, + "name": "ght", + "value": 103.676 + } + ], + "message": "success" +} +``` # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch Dengue Sensors data for Puerto Rico for epiweek `201501`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pvt_dengue_sensors(auth = 'auth_token', names = 'ght', locations = 'pr', epiweeks = 201501) +print(res) +``` + +### Python + +Install the package using pip: + +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.dengue_sensors('auth_token', ['ght'], ['pr'], [201501]) +print(res['result'], res['message'], len(res['epidata'])) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$dengue_sensors(auth = "auth_token", sensors = list("gft"), locations = list("pr"), epiweeks = list(201501)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.dengue_sensors('auth_token', ['gft'], ['pr'], [201501]) +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/dengue_nowcast.md b/docs/api/dengue_nowcast.md index 52dc80fca..f7c0cc53a 100644 --- a/docs/api/dengue_nowcast.md +++ b/docs/api/dengue_nowcast.md @@ -6,19 +6,30 @@ nav_order: 2 --- # Delphi's Dengue Nowcast +{: .no_toc} -This is the API documentation for accessing the Dengue Nowcast -(`dengue_nowcast`) endpoint of [Delphi](https://delphi.cmu.edu/)'s -epidemiological data. +* **Source name:** `dengue_nowcast` +* **Earliest issue available:** 2014w01 + +* **Time type available:** epiweek +* **License:** Open access + + +## Overview +{: .no_toc} + +This endpoint provides nowcast esimtates of dengue incidence, based on historical data and reported case counts. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Delphi's Dengue Nowcast Data +## Table of contents +{: .no_toc .text-delta} -... +1. TOC +{:toc} # The API @@ -30,21 +41,119 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required - +| Parameter | Description | Type | +| --- | --- | --- | +| `epiweeks` | epiweeks | `list` of epiweeks | +| `locations` | locations | `list` of location labels | ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|-----------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].location` | location label | string | +| `epidata[].epiweek` | epiweek | integer | +| `epidata[].value` | nowcast value | float | +| `epidata[].std` | standard deviation | float | +| `message` | `success` or error message | string | # Example URLs - +### Dengue Nowcast on 2015w01 (Puerto Rico) +https://api.delphi.cmu.edu/epidata/dengue_nowcast/?locations=pr&epiweeks=201401-202301 + +```json +{ + "result": 1, + "epidata": [ + { + "location": "pr", + "epiweek": 201501, + "value": 12.34, + "std": 1.23 + } + ], + "message": "success" +} +``` # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch Dengue Nowcast data for Puerto Rico for epiweeks `201401` to `202301`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_dengue_nowcast(locations = 'pr', epiweeks = epirange(201401, 202301)) +print(res) +``` + +### Python + +Install the package using pip: + +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.dengue_nowcast(['pr'], EpiRange(201401, 202301)) +print(res['result'], res['message'], len(res['epidata'])) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +For modern clients, we recommend using [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following clients are considered legacy: [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$dengue_nowcast(locations = list("pr"), epiweeks = list(201501)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): + +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +````python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.dengue_nowcast(['pr'], [201501]) +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index 6437d58a3..36f2fdf83 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -16,10 +16,6 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Delphi's Digital Surveillance Sensors Data - -... - **Note:** this repository was built to support modeling and forecasting efforts surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic, syndromic surveillance data, like ILI data (influenza-like illness) through @@ -73,7 +69,7 @@ Notes: # Example URLs ### Delphi's Digital Surveillance SAR3 Sensor on 2020w01 (national) -https://api.delphi.cmu.edu/epidata/sensors/?names=sar3&locations=nat&epiweeks=202001 +https://api.delphi.cmu.edu/epidata/sensors/?auth=...&names=sar3&locations=nat&epiweeks=202001 ```json { @@ -93,45 +89,82 @@ https://api.delphi.cmu.edu/epidata/sensors/?names=sar3&locations=nat&epiweeks=20 # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -The following samples show how to import the library and fetch national Delphi's Digital Surveillance SAR3 Sensor data for epiweeks `201940` and `202001-202010` (11 weeks total). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch national Delphi's Digital Surveillance SAR3 Sensor data for epiweeks `201501-202001`. + + +### R + +```R +library(epidatr) +# Fetch data +res <- pvt_sensors(auth = 'SECRET_API_AUTH_SENSORS', locations = 'nat', +names = 'sar3', epiweeks = epirange(201501, 202001)) +print(res) +``` + +### Python + +Install the package using pip: + +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.sensors(['nat'], ['sar3'], EpiRange(201501, 202001)) +print(res['result'], res['message'], len(res['epidata'])) +``` ### JavaScript (in a web browser) -````html +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html -```` +``` -### Python +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$sensors(locations = list("nat"), sensors = list("sar3"), epiweeks = Epidata$range(201501, 202001)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) Optionally install the package using pip(env): -````bash + +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data -res = Epidata.sensors(['nat'], ['sar3'], [201940, Epidata.range(202001, 202010)]) +res = Epidata.sensors(['nat'], ['sar3'], Epidata.range(201501, 202001)) print(res['result'], res['message'], len(res['epidata'])) -```` - -### R - -````R -# Import -source('delphi_epidata.R') -# Fetch data -res <- Epidata$sensors(list('nat'), list('sar3') list(201940, Epidata$range(202001, 202010))) -cat(paste(res$result, res$message, length(res$epidata), "\n")) -```` +``` diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index c379fe369..b88cf886e 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -6,18 +6,32 @@ nav_order: 2 --- # ECDC ILI +{: .no_toc} -This is the API documentation for accessing the ECDC ILI (`ecdc_ili`) endpoint -of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. +* **Source name:** `ecdc_ili` +* **Earliest issue available:** 2003w40 +* **Regions available:** European countries ([full list](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/ecdc_regions.txt)) +* **Time type available:** epiweek +* **License:** Open access + + +## Overview +{: .no_toc} + +This data source provides weekly influenza-like illness (ILI) data for European countries, as reported by the European Centre for Disease Prevention and Control (ECDC). General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## ECDC ILI Data +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + -ECDC ILI data from ECDC website. ... # The API @@ -29,17 +43,21 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required -| Parameter | Description | Type | -|------------|-------------|-------------------------------------------------------------------------------------------------------------| -| `epiweeks` | epiweeks | `list` of epiweeks | -| `regions` | regions | `list` of [location](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/ecdc_regions.txt) labels | +## Parameters + +### Required + +| Parameter | Description | Type | +| --- | --- | --- | +| `epiweeks` | epiweeks | `list` of epiweeks | +| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/ecdc_regions.txt) labels | ### Optional -| Parameter | Description | Type | -|-----------|--------------------------------------------|--------------------| -| `issues` | issues | `list` of epiweeks | -| `lag` | # weeks between each epiweek and its issue | integer | +| Parameter | Description | Type | +| --- | --- | --- | +| `issues` | issues | `list` of epiweeks | +| `lag` | # weeks between each epiweek and its issue | integer | Notes: - If both `issues` and `lag` are specified, only `issues` is used. @@ -47,17 +65,118 @@ If neither is specified, the current issues are used. ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|---------------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].release_date` | date of release | string | +| `epidata[].region` | region name | string | +| `epidata[].issue` | epiweek of issue | integer | +| `epidata[].epiweek` | epiweek of data | integer | +| `epidata[].lag` | lag in weeks | integer | +| `epidata[].count` | number of ILI cases | integer | +| `epidata[].rate` | ILI rate | float | +| `message` | `success` or error message | string | # Example URLs - +### ECDC ILI in Austria on 2020w01 +https://api.delphi.cmu.edu/epidata/ecdc_ili/?regions=austria&epiweeks=202001 + +```json +{ + "result": 1, + "epidata": [ + { + "release_date": "2020-01-10", + "region": "Austria", + "issue": 202001, + "epiweek": 202001, + "lag": 0, + "count": 123, + "rate": 12.34 + } + ], + "message": "success" +} +``` # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch ECDC ILI data for Austria for epiweeks `202001` and `202002`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_ecdc_ili(regions = 'austria', epiweeks = c(202001, 202002)) +print(res) +``` + +### Python + +Install the package using pip: + +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.ecdc_ili(['austria'], [202001, 202002]) +print(res['result'], res['message'], len(res['epidata'])) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$ecdc_ili(regions = list("austria"), epiweeks = list(202001, 202002)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): + +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.ecdc_ili(['austria'], [202001, 202002]) +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index 79ddd15ef..6672757fe 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -6,18 +6,32 @@ nav_order: 2 --- # FluSurv +{: .no_toc} -This is the API documentation for accessing the FluSurv (`flusurv`) endpoint of -[Delphi](https://delphi.cmu.edu/)'s epidemiological data. +* **Source name:** `flusurv` +* **Earliest issue available:** 2009w40 +* **Data source:** [Laboratory-Confirmed Influenza Hospitalizations](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html) +* **Location available:** CA, CO, CT, GA, IA, ID, MD, MI, MN, NM, NY_albany, NY_rochester, OH, OK, OR, RI, SD, TN, UT, network_all, network_eip, network_ihsp ([full list of locations](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/flusurv_locations.txt)) +* **Time type available:** epiweek + + + + +## Overview +{: .no_toc} + +This data source provides laboratory-confirmed influenza hospitalization rates from the FluSurv-NET surveillance system. The data includes age-stratified hospitalization rates and rates by race, sex, and flu type, when available. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## FluSurv Data +## Table of contents +{: .no_toc .text-delta} -FluSurv-NET data (flu hospitaliation rates) from CDC. +1. TOC +{:toc} See also: - @@ -130,45 +144,79 @@ Notes: # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch CA FluView Clinical data for epiweeks `201940` and `202001-202010` (11 weeks total). +### R + +```R +library(epidatr) +# Fetch data +res <- pub_flusurv(locations = "CA", epiweeks = epirange(201701, 201801)) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_flusurv(locations="CA", epiweeks=EpiRange(201701, 201801)) +print(res) +``` + ### JavaScript (in a web browser) -````html +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html -```` +``` -### Python +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$flusurv(locations = list("CA"), epiweeks = list(Epidata$range(201701, 201801))) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data -res = Epidata.flusurv(['ca'], [201940, Epidata.range(202001, 202010)]) +res = Epidata.flusurv(['CA'], [Epidata.range(201701, 201801)]) print(res['result'], res['message'], len(res['epidata'])) -```` - -### R - -````R -# Import -source('delphi_epidata.R') -# Fetch data -res <- Epidata$flusurv(list('ca'), list(201940, Epidata$range(202001, 202010))) -cat(paste(res$result, res$message, length(res$epidata), "\n")) -```` +``` +``` diff --git a/docs/api/fluview.md b/docs/api/fluview.md index 34d878cd7..0ff327abd 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -5,26 +5,24 @@ grand_parent: Other Endpoints (COVID-19 and Other Diseases) nav_order: 1 --- -# FluView +# FluView (ILINet) +{: .no_toc} -This is the API documentation for accessing the FluView (`fluview`) endpoint of -[Delphi](https://delphi.cmu.edu/)'s epidemiological data. +* **Source name:** `fluview` +* **Data source:** [United States Centers for Disease Control and Prevention](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) (CDC) +* **Earliest issue available:** 1997w40 +* **Date of last change:** [Weekly (typically Fridays)] +* **Available for:** nat, hhs1-hhs10, and cen1-cen9 ([full list of regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)) +* **Time type available:** epiweek + * **License:** Open Access / [CDC](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) + +Influenza-like illness (ILI) from U.S. Outpatient Influenza-like Illness Surveillance Network (ILINet). General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## FluView Data - -Influenza-like illness (ILI) from U.S. Outpatient Influenza-like Illness Surveillance Network (ILINet). - - Data source: [United States Centers for Disease Control and Prevention](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) (CDC) - - Temporal Resolution: Weekly* from 1997w40 - - Spatial Resolution: National, [HHS regions](https://www.hhs.gov/about/agencies/iea/regional-offices/index.html), [Census divisions](https://www2.census.gov/geo/pdfs/maps-data/maps/reference/us_regdiv.pdf), most States and Territories, and some Cities (full list [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/acquisition/fluview/fluview_locations.py)) - - Open access - -\* Data is usually released on Friday - # The API The base URL is: https://api.delphi.cmu.edu/epidata/fluview/ @@ -55,23 +53,23 @@ If neither is specified, the current issues are used. ## Response | Field | Description | Type | -|---------------------------|-----------------------------------------------------------------|------------------| +|---------------------------|-----------------------------------------------------------------|---------------------| | `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | | `epidata` | list of results | array of objects | -| `epidata[].release_date` | | string or null | -| `epidata[].region` | | string | -| `epidata[].issue` | | integer | -| `epidata[].epiweek` | | integer | -| `epidata[].lag` | | integer | -| `epidata[].num_ili` | | integer | -| `epidata[].num_patients` | | integer | -| `epidata[].num_providers` | | integer | -| `epidata[].num_age_0` | | integer or null | -| `epidata[].num_age_1` | | integer or null | -| `epidata[].num_age_2` | | integer or null | -| `epidata[].num_age_3` | | integer or null | -| `epidata[].num_age_4` | | integer or null | -| `epidata[].num_age_5` | | integer or null | +| `epidata[].release_date` | date when data was released | string or null | +| `epidata[].region` | region identifier | string | +| `epidata[].issue` | epiweek of publication | integer | +| `epidata[].epiweek` | epiweek for which data is valid | integer | +| `epidata[].lag` | number of weeks between epiweek and issue | integer | +| `epidata[].num_ili` | number of ILI cases | integer | +| `epidata[].num_patients` | total number of patients | integer | +| `epidata[].num_providers` | number of reporting providers | integer | +| `epidata[].num_age_0` | number of ILI cases for ages 0-4 | integer or null | +| `epidata[].num_age_1` | number of ILI cases for ages 5-24 | integer or null | +| `epidata[].num_age_2` | number of ILI cases for ages 25-49 | integer or null | +| `epidata[].num_age_3` | number of ILI cases for ages 50-64 | integer or null | +| `epidata[].num_age_4` | number of ILI cases for ages 65+ | integer or null | +| `epidata[].num_age_5` | number of ILI cases with unknown age | integer or null | | `epidata[].wili` | weighted percent influenza-like illness | float | | `epidata[].ili` | percent influenza-like illness | float | | `message` | `success` or error message | string | @@ -122,46 +120,79 @@ https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201453&issues=2 # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -The following samples show how to import the library and fetch national FluView data for epiweeks `201440` and `201501-201510` (11 weeks total). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch national FluView data for epiweeks `201501-201510`. + + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_fluview(regions = "nat", epiweeks = epirange(201501, 201510)) +print(res) +``` + +### Python +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_fluview(regions="nat", epiweeks=EpiRange(201501, 201510)) +print(res) +``` ### JavaScript (in a web browser) -````html +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html -```` +``` -### Python +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$fluview(regions = list("nat"), epiweeks = list(Epidata$range(201501, 201510))) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data -res = Epidata.fluview(['nat'], [201440, Epidata.range(201501, 201510)]) +res = Epidata.fluview(['nat'], [Epidata.range(201501, 201510)]) print(res['result'], res['message'], len(res['epidata'])) -```` - -### R - -````R -# Import -source('delphi_epidata.R') -# Fetch data -res <- Epidata$fluview(list('nat'), list(201440, Epidata$range(201501, 201510))) -cat(paste(res$result, res$message, length(res$epidata), "\n")) -```` +``` diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index ca2b7b801..6b6d2a633 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -6,19 +6,32 @@ nav_order: 1 --- # FluView Clinical +{: .no_toc} -This is the API documentation for accessing the FluView Clinical -(`fluview_clinical`) endpoint of [Delphi](https://delphi.cmu.edu/)'s -epidemiological data. +* **Source name:** `fluview_clinical` +* **Earliest issue available:** 2010w40 +* **Available for:** nat, hhs1-hhs10, and cen1-cen9 ([full list of regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)) +* **Time type available:** epiweek +* **License:** Open Access + + +## Overview +{: .no_toc} + +This data source provides age-stratified clinical data on laboratory-confirmed influenza from the US Flu View system. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## FluView Clinical Data +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + -... # The API @@ -52,17 +65,17 @@ If neither is specified, the current issues are used. |------------------------------|-----------------------------------------------------------------|------------------| | `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | | `epidata` | list of results | array of objects | -| `epidata[].release_date` | | string | -| `epidata[].region` | | string | -| `epidata[].issue` | | integer | -| `epidata[].epiweek` | | integer | -| `epidata[].lag` | | integer | -| `epidata[].total_specimens` | | integer | -| `epidata[].total_a` | | integer | -| `epidata[].total_b` | | integer | -| `epidata[].percent_positive` | | float | -| `epidata[].percent_a` | | float | -| `epidata[].percent_b` | | float | +| `epidata[].release_date` | date when data was released | string | +| `epidata[].region` | region identifier | string | +| `epidata[].issue` | epiweek of publication | integer | +| `epidata[].epiweek` | epiweek for which data is valid | integer | +| `epidata[].lag` | number of weeks between epiweek and issue | integer | +| `epidata[].total_specimens` | total number of specimens tested | integer | +| `epidata[].total_a` | total specimens positive for influenza A | integer | +| `epidata[].total_b` | total specimens positive for influenza B | integer | +| `epidata[].percent_positive` | percentage of specimens testing positive for influenza | float | +| `epidata[].percent_a` | percentage of specimens testing positive for influenza A | float | +| `epidata[].percent_b` | percentage of specimens testing positive for influenza B | float | | `message` | `success` or error message | string | # Example URLs @@ -75,7 +88,7 @@ https://api.delphi.cmu.edu/epidata/fluview_clinical/?regions=nat&epiweeks=202001 "result": 1, "epidata": [ { - "release_date": "2020-04-10", + "release_date": "2021-10-08", "region": "nat", "issue": 202014, "epiweek": 202001, @@ -93,48 +106,79 @@ https://api.delphi.cmu.edu/epidata/fluview_clinical/?regions=nat&epiweeks=202001 } ``` - # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -The following samples show how to import the library and fetch national FluView Clinical data for epiweeks `201940` and `202001-202010` (11 weeks total). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch national FluView Clinical data for epiweeks `201601-201701`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_fluview_clinical(regions = "nat", epiweeks = epirange(201601, 201701)) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +res = Epidata.fluview_clinical(['nat'], [Epidata.range(201601, 201701)]) +print(res['result'], res['message'], len(res['epidata'])) +``` ### JavaScript (in a web browser) -````html +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html -```` +``` -### Python +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$fluview_clinical(regions = list("nat"), epiweeks = list(Epidata$range(201601, 201701))) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` -Otherwise, place `delphi_epidata.py` from this repo next to your python script. +Place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data -res = Epidata.fluview_clinical(['nat'], [201940, Epidata.range(202001, 202010)]) +res = Epidata.fluview_clinical(['nat'], [Epidata.range(201601, 201701)]) print(res['result'], res['message'], len(res['epidata'])) -```` - -### R - -````R -# Import -source('delphi_epidata.R') -# Fetch data -res <- Epidata$fluview_clinical(list('nat'), list(201940, Epidata$range(202001, 202010))) -cat(paste(res$result, res$message, length(res$epidata), "\n")) -```` +``` diff --git a/docs/api/gft.md b/docs/api/gft.md index ced862113..92fc6afd6 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -6,22 +6,31 @@ nav_order: 2 --- # Google Flu Trends +{: .no_toc} -This is the API documentation for accessing the Google Flu Trends (`gft`) -endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. +* **Source name:** `gft` +* **Data Source:** [Google Flu Trends Estimates](https://www.google.com/publicdata/explore?ds=z3bsqef7ki44ac_) ([context](https://en.wikipedia.org/wiki/Google_Flu_Trends)) +* **Earliest issue available:** 2003w40 +* **Available for:** US states, census regions, and select cities ([regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt), [states](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt), [cities](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/cities.txt)) +* **Temporal Resolution:** Weekly +* **Spatial Resolution:** National, [HHS regions](http://www.hhs.gov/iea/regional/) ([1+10](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)); by state/territory ([50+1](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)); and by city ([97](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/cities.txt)) +* **License:** Open access + + +## Overview +{: .no_toc} + +This data source provides influenza activity estimates from Google Flu Trends, which used search query data to track ILI activity. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Google Flu Trends Data +## Table of contents +{: .no_toc .text-delta} -Estimate of influenza activity based on volume of certain search queries. Google has discontinued Flu Trends, and this is now a static endpoint. - - Data Source: [Google Flu Trends Estimates](https://www.google.com/publicdata/explore?ds=z3bsqef7ki44ac_) ([context](https://en.wikipedia.org/wiki/Google_Flu_Trends)) - - Temporal Resolution: Weekly from 2003w40 until 2015w32 - - Spatial Resolution: National, [HHS regions](http://www.hhs.gov/iea/regional/) ([1+10](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)); by state/territory ([50+1](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)); and by city ([97](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/cities.txt)) - - Open access +1. TOC # The API @@ -33,10 +42,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required +## Parameters + +### Required + | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)/[state](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)/[city](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/cities.txt) labels | +| `locations` | Locations to fetch. | `list` of strings | +| `epiweeks` | Epiweeks to fetch. Supports [`epirange()`] and defaults to all ("*") dates. | `list` of epiweeks | ## Response @@ -71,45 +84,78 @@ https://api.delphi.cmu.edu/epidata/gft/?locations=nat&epiweeks=201501 # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -The following samples show how to import the library and fetch Google Flu Trends data for epiweeks `201440` and `201501-201510` (11 weeks total). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch Google Flu Trends data for epiweeks `201501-201510`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_gft(locations = 'nat', epiweeks = epirange(201501, 201510)) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_gft(locations='nat', epiweeks=EpiRange(201501, 201510)) +print(res) +``` ### JavaScript (in a web browser) -````html +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html -```` +``` -### Python +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$gft(locations = list("nat"), epiweeks = Epidata$range(201501, 201510)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data -res = Epidata.gft(['nat'], [201440, Epidata.range(201501, 201510)]) +res = Epidata.gft(['nat'], Epidata.range(201501, 201510)) print(res['result'], res['message'], len(res['epidata'])) -```` - -### R - -````R -# Import -source('delphi_epidata.R') -# Fetch data -res <- Epidata$gft(list('nat'), list(201440, Epidata$range(201501, 201510))) -cat(paste(res$result, res$message, length(res$epidata), "\n")) -```` +``` diff --git a/docs/api/ght.md b/docs/api/ght.md index 20698e753..ef2cf8851 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -6,6 +6,13 @@ nav_order: 2 --- # Google Health Trends +{: .no_toc} + +* **Source name:** `ght` +* **Earliest issue available:** 2003w40 +* **Available for:** US states([states list](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)) and national level (US) +* **Time type available:** epiweek +* **License:** Restricted (requires auth) This is the API documentation for accessing the [Google Health Trends](https://trends.google.com/trends/fullscreen/m/IN) (`ght`) endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -15,10 +22,13 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Google Health Trends Data +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + -Estimate of influenza activity based on volume of certain search queries. -This data may be useful for real-time monitoring of diseases, as in: - Herman Anthony Carneiro, Eleftherios Mylonakis. [Google Trends: A Web-Based Tool for Real-Time Surveillance of Disease Outbreaks](https://doi.org/10.1086/630200). Clinical Infectious Diseases, Volume 49, Issue 10, 15 November 2009, Pages 1557–1564. - Abel Brodeur, Andrew E. Clark, Sarah Fleche, Nattavudh Powdthavee. @@ -44,17 +54,111 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|-----------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].location` | location label | string | +| `epidata[].epiweek` | epiweek | integer | +| `epidata[].query` | search query | string | +| `epidata[].value` | search volume | float | +| `message` | `success` or error message | string | # Example URLs - +### Google Health Trends for "how to get over the flu" on 2015w01 (US) +https://api.delphi.cmu.edu/epidata/ght/?auth=...&locations=US&epiweeks=201501&query=how%20to%20get%20over%20the%20flu + +```json +{ + "result": 1, + "epidata": [ + { + "location": "US", + "epiweek": 201501, + "query": "flu", + "value": 9.113 + } + ], + "message": "success" +} +``` # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch GHT data for "how to get over the flu" in the US for epiweek `201501`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pvt_ght(auth = 'auth_token', locations = 'US', epiweeks = 201501, + query = "how to get over the flu") +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.ght('auth_token', ['US'], [201501], 'how to get over the flu') +print(res['result'], res['message'], len(res['epidata'])) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$ght(auth = "auth_token", locations = list("US"), epiweeks = list(201501), query = "how to get over the flu") +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.ght('auth_token', ['US'], [201501], 'how to get over the flu') +print(res['result'], res['message'], len(res['epidata'])) +``` From 14df264d86b4e0f0aa1893c9603cc31fdbdd1cf6 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 25 Nov 2025 23:11:08 -0800 Subject: [PATCH 32/64] docs: Add complete header and code samples to missing endpoints --- docs/api/01meta.md | 76 +++++++++++++++- docs/api/README.md | 12 +-- docs/api/cdc.md | 154 ++++++++++++++++++++++++++++--- docs/api/ili_nearby_nowcast.md | 117 +++++++++++++++++------- docs/api/kcdc_ili.md | 160 +++++++++++++++++++++++++++++---- docs/api/nidss_dengue.md | 101 +++++++++++++++------ docs/api/nidss_flu.md | 106 +++++++++++++++------- docs/api/norostat.md | 140 ++++++++++++++++++++++++++--- docs/api/norostat_meta.md | 144 ++++++++++++++++++++++++++--- docs/api/paho_dengue.md | 150 ++++++++++++++++++++++++++++--- docs/api/quidel.md | 141 +++++++++++++++++++++++++++-- docs/api/twitter.md | 146 +++++++++++++++++++++++++----- docs/api/wiki.md | 131 ++++++++++++++++++--------- 13 files changed, 1338 insertions(+), 240 deletions(-) diff --git a/docs/api/01meta.md b/docs/api/01meta.md index 803a0a9e1..55fe1e484 100644 --- a/docs/api/01meta.md +++ b/docs/api/01meta.md @@ -108,4 +108,78 @@ https://api.delphi.cmu.edu/epidata/meta/ # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch API metadata. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_meta() +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_meta() +print(res) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$meta() +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.meta() +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/README.md b/docs/api/README.md index 6f38d8cf6..9c4977a62 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -117,7 +117,7 @@ The parameters available for each source are documented in each linked source-sp | [`flusurv`](flusurv.md) | FluSurv | FluSurv-NET data (flu hospitaliation rates) from CDC. | no | | [`fluview`](fluview.md) | FluView | Influenza-like illness (ILI) from U.S. Outpatient Influenza-like Illness Surveillance Network (ILINet). | no | | [`fluview_meta`](fluview_meta.md) | FluView Metadata | Summary data about [`fluview`](fluview.md). | no | -| [`fluview_clinical`](fluview_clinical.md) | FluView Clinical | ... | no | +| [`fluview_clinical`](fluview_clinical.md) | FluView Clinical | Clinical flu data. | no | | [`gft`](gft.md) | Google Flu Trends | Estimate of influenza activity based on volume of certain search queries. Google has discontinued Flu Trends, and this is now a static endpoint. | no | | [`ght`](ght.md) | Google Health Trends | Estimate of influenza activity based on volume of certain search queries. | yes | | [`kcdc_ili`](kcdc_ili.md) | KCDC ILI | KCDC ILI data from KCDC website. | no | @@ -125,7 +125,7 @@ The parameters available for each source are documented in each linked source-sp | [`nidss_flu`](nidss_flu.md) | NIDSS Flu | Outpatient ILI from Taiwan's National Infectious Disease Statistics System (NIDSS). | no | | [`nowcast`](nowcast.md) | ILI Nearby | A nowcast of U.S. national, regional, and state-level (weighted) percent ILI, available seven days (regionally) or five days (state-level) before the first ILINet report for the corresponding week. | no | | [`quidel`](quidel.md) | Quidel | Data provided by Quidel Corp., which contains flu lab test results. | yes | -| [`sensors`](sensors.md) | Delphi's Digital Surveillance Sensors | ... | no | +| [`sensors`](sensors.md) | Delphi's Digital Surveillance Sensors | Digital surveillance signals for influenza. | no | | [`twitter`](twitter.md) | Twitter Stream | Estimate of influenza activity based on analysis of language used in tweets from [HealthTweets](http://HealthTweets.org/). | yes | | [`wiki`](wiki.md) | Wikipedia Access Logs | Number of page visits for selected English, Influenza-related wikipedia articles. | no | @@ -133,16 +133,16 @@ The parameters available for each source are documented in each linked source-sp | Endpoint | Name | Description | Restricted? | | --- | --- | --- | --- | -| [`dengue_nowcast`](dengue_nowcast.md) | Delphi's Dengue Nowcast | ... | ... | -| [`dengue_sensors`](dengue_sensors.md) | Delphi's Dengue Digital Surveillance Sensors | ... | ... | +| [`dengue_nowcast`](dengue_nowcast.md) | Delphi's Dengue Nowcast | Nowcast of dengue in Puerto Rico and other regions. |... | +| [`dengue_sensors`](dengue_sensors.md) | Delphi's Dengue Digital Surveillance Sensors | Digital surveillance signals for dengue. | ... | | [`nidss_dengue`](nidss_dengue.md) | NIDSS Dengue | Counts of confirmed dengue cases from Taiwan's NIDSS. | no | -| [`paho_dengue`](paho_dengue.md) | PAHO Dengue | ... | ... | +| [`paho_dengue`](paho_dengue.md) | PAHO Dengue | Dengue cases reported by PAHO. | ... | ### Norovirus Data | Endpoint | Name | Description | Restricted? | | --- | --- | --- | --- | -| [`meta_norostat`](meta_norostat.md) | NoroSTAT Metadata | ... | ... | +| [`meta_norostat`](meta_norostat.md) | NoroSTAT Metadata | Metadata for NoroSTAT data. | ... | | [`norostat`](norostat.md) | NoroSTAT | Suspected and confirmed norovirus outbreaks reported by state health departments to the CDC. | ... | ### Deprecated diff --git a/docs/api/cdc.md b/docs/api/cdc.md index 29ae7ebe8..0b3e31a19 100644 --- a/docs/api/cdc.md +++ b/docs/api/cdc.md @@ -6,18 +6,37 @@ nav_order: 2 --- # CDC +{: .no_toc} -This is the API documentation for accessing the CDC (`cdc`) endpoint of -[Delphi](https://delphi.cmu.edu/)'s epidemiological data. + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `cdc` | +| **Data Source** | CDC influenza surveillance data | +| **Geographic Coverage** | National, HHS regions, Census divisions, and US states | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2013w02 (2013-01-06) | + + + +## Overview +{: .no_toc} + +This data source provides CDC-collected influenza surveillance data from various sources. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## CDC Data +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + -... # The API @@ -33,21 +52,130 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | --- | --- | --- | | `auth` | password | string | | `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)/[state](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt) labels | +| `locations` | locations | `list` of location codes: `nat` (national), HHS regions (`hhs1`-`hhs10`), Census divisions (`cen1`-`cen9`), or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|-----------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].location` | location label | string | +| `epidata[].epiweek` | epiweek | integer | +| `epidata[].num1` | number of hits for datasource 1 | integer | +| `epidata[].num2` | number of hits for datasource 2 | integer | +| `epidata[].num3` | number of hits for datasource 3 | integer | +| `epidata[].num4` | number of hits for datasource 4 | integer | +| `epidata[].num5` | number of hits for datasource 5 | integer | +| `epidata[].num6` | number of hits for datasource 6 | integer | +| `epidata[].num7` | number of hits for datasource 7 | integer | +| `epidata[].num8` | number of hits for datasource 8 | integer | +| `epidata[].total` | total page hits across all datasources | integer | +| `epidata[].value` | computed value (may be null) | float or null | +| `message` | `success` or error message | string | # Example URLs - +### CDC Page Hits on 2015w01 (national) +https://api.delphi.cmu.edu/epidata/cdc/?auth=...&locations=nat&epiweeks=201501 + +```json +{ + "result": 1, + "epidata": [ + { + "location": "nat", + "epiweek": 201501, + "num1": 91858, + "num2": 81121, + "num3": 89511, + "num4": 52278, + "num5": 16219, + "num6": 87327, + "num7": 38310, + "num8": 51461, + "total": 4252190, + "value": null + } + ], + "message": "success" +} +``` # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch CDC data for national level for epiweek `201501`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pvt_cdc(auth = 'auth_token', locations = 'nat', epiweeks = 201501) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pvt_cdc(auth='auth_token', locations=['nat'], epiweeks=[201501]) +print(res) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$cdc(auth = "auth_token", epiweeks = list(201501), locations = list("nat")) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.cdc('auth_token', [201501], ['nat']) +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index defd13b22..066f70e0e 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -7,24 +7,40 @@ permalink: api/nowcast.html --- # ILI Nearby Nowcast +{: .no_toc} -This is the documentation of the API for accessing the ILI Nearby (`nowcast`) endpoint of -the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `nowcast` | +| **Data Source:** | [Delphi's ILI Nearby system](https://delphi.cmu.edu/nowcast/) +| **Dataset Type** | Predictive (Leading Indicator) | +| **Geographic Coverage** | National, [HHS regions](http://www.hhs.gov/iea/regional/), [Census divisions](http://www.census.gov/econ/census/help/geography/regions_and_divisions.html) ([1+10+9](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)), and by state/territory ([51](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Released Friday; updated Sunday & Monday | +| **Earliest Date** | 2010w30 | +| **License** | Open Access | + +## Overview +{: .no_toc} + +The ILI Nearby endpoint provides a "nowcast" predictive estimate of the percentage of outpatient visits due to Influenza-Like Illness (ILI). + +This system uses a sensor-fusion approach to estimate the current level of flu activity before the official CDC reports are finalized. It is available: +* **National/Regional:** 7 days before the first official CDC ILINet report. +* **State-level:** 5 days before the first official CDC ILINet report. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## ILI Nearby Data -A nowcast of U.S. national, regional, and state-level (weighted) %ILI, available seven days (regionally) or five days (state-level) before the first ILINet report for the corresponding week. - - Source: [Delphi's ILI Nearby system](https://delphi.cmu.edu/nowcast/) - - Temporal Resolution: Weekly, from 2010w30* - - Spatial Resolution: National, [HHS regions](http://www.hhs.gov/iea/regional/), [Census divisions](http://www.census.gov/econ/census/help/geography/regions_and_divisions.html) ([1+10+9](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)), and by state/territory ([51](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)) - - Open access +# Table of contents +{: .no_toc .text-delta} -\* Data is usually released on Friday and updated on Sunday and Monday +1. TOC +{:toc} # The API @@ -47,10 +63,10 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a |----------------------|-----------------------------------------------------------------|------------------| | `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | | `epidata` | list of results | array of objects | -| `epidata[].location` | | string | -| `epidata[].epiweek` | | integer | -| `epidata[].value` | | float | -| `epidata[].std` | | float | +| `epidata[].location` | location identifier (e.g., 'nat', state code, HHS region, census division) | string | +| `epidata[].epiweek` | epiweek for the nowcast estimate | integer | +| `epidata[].value` | nowcast estimate of %ILI (percentage of outpatient visits due to ILI) | float | +| `epidata[].std` | standard deviation of the nowcast estimate | float | | `message` | `success` or error message | string | # Example URLs @@ -76,45 +92,78 @@ https://api.delphi.cmu.edu/epidata/nowcast/?locations=nat&epiweeks=202001 # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -The following samples show how to import the library and fetch national ILI Nearby data for epiweeks `201940` and `202001-202010` (11 weeks total). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch national ILI Nearby data for epiweeks `202001-202010` (10 weeks total). + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_nowcast(locations = 'nat', epiweeks = epirange(202001, 202010)) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_nowcast(locations=['nat'], epiweeks=EpiRange(202001, 202010)) +print(res) +``` ### JavaScript (in a web browser) -````html +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html -```` +``` -### Python +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$nowcast(locations = list("nat"), epiweeks = Epidata$range(202001, 202010)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data -res = Epidata.nowcast(['nat'], [201940, Epidata.range(202001, 202010)]) +res = Epidata.nowcast(['nat'], Epidata.range(202001, 202010)) print(res['result'], res['message'], len(res['epidata'])) -```` - -### R - -````R -# Import -source('delphi_epidata.R') -# Fetch data -res <- Epidata$nowcast(list('nat'), list(201940, Epidata$range(202001, 202010))) -cat(paste(res$result, res$message, length(res$epidata), "\n")) -```` +``` diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index 340d886d2..3645c9e51 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -6,6 +6,24 @@ nav_order: 2 --- # KCDC ILI +{: .no_toc} + + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `kcdc_ili` | +| **Data Source:** | [KCDC](https://www.kdca.go.kr/) (Korea Disease Control and Prevention Agency) ILI surveillance | +| **Geographic Coverage** | ROK (Republic of Korea) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2004w36 | + + + +## Overview +{: .no_toc} + +This data source provides weekly influenza-like illness (ILI) data for the Republic of Korea, as reported by the Korea Centers for Disease Control and Prevention (KCDC). This is the API documentation for accessing the KCDC ILI (`kcdc_ili`) endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -14,9 +32,13 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## KCDC ILI Data +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + -KCDC ILI data from KCDC website. ... # The API @@ -28,17 +50,21 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required -| Parameter | Description | Type | -|------------|-------------|--------------------| -| `epiweeks` | epiweeks | `list` of epiweeks | -| `regions` | regions | `ROK` | +## Parameters + +### Required + +| Parameter | Description | Type | +| --- | --- | --- | +| `regions` | Regions to fetch. | `list` of strings | +| `epiweeks` | Epiweeks to fetch. Supports [`epirange()`] and defaults to all ("*") dates. | `list` of epiweeks | ### Optional -| Parameter | Description | Type | -|-----------|--------------------------------------------|--------------------| -| `issues` | issues | `list` of epiweeks | -| `lag` | # weeks between each epiweek and its issue | integer | +| Parameter | Description | Type | +| --- | --- | --- | +| `issues` | Optionally, the issue(s) of the data to fetch. See the "Data Versioning" section for details. | `list` of epiweeks | +| `lag` | Optionally, the lag of the issues to fetch. See the "Data Versioning" section for details. | integer | Notes: - If both `issues` and `lag` are specified, only `issues` is used. @@ -46,17 +72,115 @@ If neither is specified, the current issues are used. ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|---------------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].release_date` | date of release | string | +| `epidata[].region` | region name | string | +| `epidata[].issue` | epiweek of issue | integer | +| `epidata[].epiweek` | epiweek of data | integer | +| `epidata[].lag` | lag in weeks | integer | +| `epidata[].ili` | percent ILI | float | +| `epidata[].visits` | number of visits | integer | +| `message` | `success` or error message | string | # Example URLs - +### KCDC ILI in ROK on 2020w01 +https://api.delphi.cmu.edu/epidata/kcdc_ili/?regions=ROK&epiweeks=202001 + +```json +{ + "result": 1, + "epidata": [ + { + "release_date": "2020-01-10", + "region": "ROK", + "issue": 202001, + "epiweek": 202001, + "lag": 44, + "ili": 49.8, + } + ], + "message": "success" +} +``` # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch KCDC ILI data for ROK for epiweeks `202001` and `202002`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_kcdc_ili(regions = 'ROK', epiweeks = c(202001, 202002)) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_kcdc_ili(regions=['ROK'], epiweeks=[202001, 202002]) +print(res) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$kcdc_ili(regions = list("ROK"), epiweeks = list(202001, 202002)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.kcdc_ili(['ROK'], [202001, 202002]) +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 33cd2ffc3..91ef8fe85 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -6,6 +6,21 @@ nav_order: 2 --- # NIDSS Dengue +{: .no_toc} + + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `nidss_dengue` | +| **Data Source** | [Taiwan CDC](http://nidss.cdc.gov.tw/en/SingleDisease.aspx?dc=1&dt=4&disease=061&position=1)| +| **Geographic Coverage** | [hexchotomy region](https://en.wikipedia.org/wiki/Regions_of_Taiwan#Hexchotomy) ([6+1](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt)) and [city/county](https://en.wikipedia.org/wiki/List_of_administrative_divisions_of_Taiwan) ([22](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_locations.txt)) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2003w01 | +| **License** | [Open Access](https://data.gov.tw/license) | + +## Overview +{: .no_toc} This is the documentation of the API for accessing the Taiwan National Infectious Disease Statistics System Dengue (`nidss_dengue`) endpoint of the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -15,13 +30,12 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## NIDSS Dengue Data +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} -Counts of confirmed dengue cases from Taiwan's National Infectious Disease Statistics System (NIDSS). - - Data source: [Taiwan CDC](http://nidss.cdc.gov.tw/en/SingleDisease.aspx?dc=1&dt=4&disease=061&position=1) - - Temporal Resolution: Weekly from 2003w01 - - Spatial Resolution: By [hexchotomy region](https://en.wikipedia.org/wiki/Regions_of_Taiwan#Hexchotomy) ([6+1](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt)) and by [city/county](https://en.wikipedia.org/wiki/List_of_administrative_divisions_of_Taiwan) ([22](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_locations.txt)) - - Open access # The API @@ -71,48 +85,81 @@ https://api.delphi.cmu.edu/epidata/nidss_dengue/?locations=nationwide&epiweeks=2 # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -The following samples show how to import the library and fetch national NIDSS Dengue data for epiweeks `201440` and `201501-201510` (11 weeks total). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch national NIDSS Dengue data for epiweeks `201501-201510` (10 weeks total). + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_nidss_dengue(locations = 'nationwide', epiweeks = epirange(201501, 201510)) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_nidss_dengue(locations=['nationwide'], epiweeks=EpiRange(201501, 201510)) +print(res) +``` ### JavaScript (in a web browser) -````html +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html -```` +``` -### Python +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$nidss_dengue(regions = list("nationwide"), epiweeks = Epidata$range(201501, 201510)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data -res = Epidata.nidss_dengue(['nationwide'], [201440, Epidata.range(201501, 201510)]) +res = Epidata.nidss_dengue(['nationwide'], Epidata.range(201501, 201510)) print(res['result'], res['message'], len(res['epidata'])) -```` - -### R - -````R -# Import -source('delphi_epidata.R') -# Fetch data -res <- Epidata$nidss_dengue(list('nationwide'), list(201440, Epidata$range(201501, 201510))) -cat(paste(res$result, res$message, length(res$epidata), "\n")) -```` +``` # Source and Licensing diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index d35e991d3..ffabba5ad 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -6,6 +6,23 @@ nav_order: 2 --- # NIDSS Flu +{: .no_toc} + + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `nidss_flu` | +| **Source** | [Taiwan CDC](http://nidss.cdc.gov.tw/en/CDCWNH01.aspx?dc=wnh) | +| **Geographic Coverage** | [hexchotomy region](https://en.wikipedia.org/wiki/Regions_of_Taiwan#Hexchotomy) ([6+1](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt)) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2008w14 | +| **License** | [Open Access](https://data.gov.tw/license) | + +## Overview +{: .no_toc} + +This data source provides weekly influenza case counts for Taiwan, as reported by the National Infectious Disease Statistics System (NIDSS). This is the documentation of the API for accessing the Taiwan National Infectious Disease Statistics System Flu (`nidss_flu`) endpoint of the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -15,15 +32,11 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## NIDSS Flu Data - -Outpatient ILI from Taiwan's National Infectious Disease Statistics System (NIDSS). - - Source: [Taiwan CDC](http://nidss.cdc.gov.tw/en/CDCWNH01.aspx?dc=wnh) - - Temporal Resolution: Weekly* from 2008w14 - - Spatial Resolution: By [hexchotomy region](https://en.wikipedia.org/wiki/Regions_of_Taiwan#Hexchotomy) ([6+1](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt)) - - Open access +## Table of contents +{: .no_toc .text-delta} -\* Data is usually released on Tuesday +1. TOC +{:toc} # The API @@ -92,48 +105,81 @@ https://api.delphi.cmu.edu/epidata/nidss_flu/?regions=nationwide&epiweeks=201501 # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -The following samples show how to import the library and fetch national NIDSS Flu data for epiweeks `201440` and `201501-201510` (11 weeks total). +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch national NIDSS Flu data for epiweeks `201501-201510` (10 weeks total). + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_nidss_flu(regions = 'nationwide', epiweeks = epirange(201501, 201510)) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_nidss_flu(regions=['nationwide'], epiweeks=EpiRange(201501, 201510)) +print(res) +``` ### JavaScript (in a web browser) -````html +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html -```` +``` -### Python +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$nidss_flu(regions = list("nationwide"), epiweeks = Epidata$range(201501, 201510)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data -res = Epidata.nidss_flu(['nationwide'], [201440, Epidata.range(201501, 201510)]) +res = Epidata.nidss_flu(['nationwide'], Epidata.range(201501, 201510)) print(res['result'], res['message'], len(res['epidata'])) -```` - -### R - -````R -# Import -source('delphi_epidata.R') -# Fetch data -res <- Epidata$nidss_flu(list('nationwide'), list(201440, Epidata$range(201501, 201510))) -cat(paste(res$result, res$message, length(res$epidata), "\n")) -```` +``` # Source and Licensing diff --git a/docs/api/norostat.md b/docs/api/norostat.md index 80c289c84..587f42bbb 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.md @@ -6,20 +6,37 @@ nav_order: 2 --- # NoroSTAT +{: .no_toc} -This is the documentation of the API for accessing the NoroSTAT (`norostat`) endpoint of -the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `norostat` | +| **Data Source** | [CDC NoroSTAT](https://www.cdc.gov/norovirus/php/reporting/norostat-data.html) metadata endpoint (requires authentication) | +| **Dataset Type** | Surveillance (Inactive) | +| **Geographic Coverage** | Only a specific list of full state names are permitted. See the `locations` output of the [meta_norostat](meta_norostat.html#norostat-metadata-1) endpoint for the allowed values. | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - Delphi stopped stopped acquiring data from this data source in November 2020. | +| **Earliest Date** | 2012w31 | + + + +## Overview +{: .no_toc} + +This data source provides norovirus surveillance data for US states, collected through the NoroSTAT system. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -**NOTE**: Delphi stopped stopped acquiring data from this data source in November 2020. +## Table of contents +{: .no_toc .text-delta} -## NoroSTAT Data +1. TOC +{:toc} -... # The API @@ -31,21 +48,116 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required - +| Parameter | Description | Type | +| --- | --- | --- | +| `auth` | password | string | +| `epiweeks` | epiweeks | `list` of epiweeks | +| `locations` | locations | `string` with specific list of full state names | ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|---------------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].release_date` | date when data was released | date (YYYY-MM-DD)| +| `epidata[].epiweek` | epiweek for the data point | integer | +| `epidata[].value` | count of norovirus outbreaks | integer | +| `message` | `success` or error message | string | # Example URLs - +### NoroSTAT on 2015w01 +https://api.delphi.cmu.edu/epidata/norostat/?auth=...&location=Minnesota%2C%20Ohio%2C%20Oregon%2C%20Tennessee%2C%20and%20Wisconsin&epiweeks=201233 + +```json +{ + "result": 1, + "epidata": [ + { + "release_date": "2014-10-21", + "epiweek": 201233, + "value": 2 + } + ], + "message": "success" +} +``` # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch NoroSTAT data for the most recent available states for epiweek `201501`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pvt_norostat(auth = 'auth_token', locations = 'Minnesota, Ohio, Oregon, Tennessee, and Wisconsin', epiweeks = 201501) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pvt_norostat(auth='auth_token', locations=['Minnesota, Ohio, Oregon, Tennessee, and Wisconsin'], epiweeks=[201501]) +print(res) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$norostat(auth = "auth_token", locations = list("Minnesota, Ohio, Oregon, Tennessee, and Wisconsin"), epiweeks = list(201501)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.norostat('auth_token', ['Minnesota, Ohio, Oregon, Tennessee, and Wisconsin'], [201501]) +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/norostat_meta.md b/docs/api/norostat_meta.md index 47b99dfd0..d25681a61 100644 --- a/docs/api/norostat_meta.md +++ b/docs/api/norostat_meta.md @@ -7,6 +7,16 @@ permalink: api/meta_norostat.html --- # NoroSTAT Metadata +{: .no_toc} + + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `meta_norostat` | +| **Data Source** | [CDC NoroSTAT](https://www.cdc.gov/norovirus/php/reporting/norostat-data.html) | +| **Update Frequency** | Inactive - Delphi stopped stopped acquiring data from this data source in November 2020. | + + This is the documentation of the API for accessing the NoroSTAT Metadata (`meta_norostat`) endpoint of the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -16,9 +26,11 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## NoroSTAT Metadata +## Table of contents +{: .no_toc .text-delta} -... +1. TOC +{:toc} # The API @@ -30,21 +42,131 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required - +| Parameter | Description | Type | +| --- | --- | --- | +| `auth` | password | string | ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|-------------------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | metadata object containing locations and releases | object | +| `epidata.locations` | list of location sets available over time | array of objects | +| `epidata.locations[].location`| comma-separated list of state names available in this release | string | +| `epidata.releases` | list of data release dates | array of objects | +| `epidata.releases[].release_date` | date when data was released (YYYY-MM-DD) | string | +| `message` | `success` or error message | string | # Example URLs - +### NoroSTAT Metadata +https://api.delphi.cmu.edu/epidata/meta_norostat/?auth=... + +```json +{ + "result": 1, + "epidata": { + "locations": [ + { + "location": "Massachusetts, Michigan, Minnesota, Nebraska, New Mexico, Ohio, Oregon, South Carolina, Tennessee, Virginia, Wisconsin, and Wyoming" + }, + { + "location": "Massachusetts, Michigan, Minnesota, New Mexico, Ohio, Oregon, South Carolina, Tennessee, Virginia, Wisconsin, and Wyoming" + }, + { + "location": "Massachusetts, Michigan, Minnesota, Ohio, Oregon, South Carolina, Tennessee, Virginia, and Wisconsin" + }, + { + "location": "Michigan, Minnesota, Ohio, Oregon, South Carolina, Tennessee, and Wisconsin" + }, + { + "location": "Minnesota, Ohio, Oregon, Tennessee, and Wisconsin" + } + ], + "releases": [ + {"release_date": "2014-10-21"}, + {"release_date": "2015-03-30"}, + ...] + }, + "message": "success" +} +``` # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch NoroSTAT Metadata. + +### R + +```R +library(epidatr) +# Fetch data +res <- pvt_meta_norostat(auth = 'auth_token') +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pvt_meta_norostat(auth='auth_token') +print(res) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$meta_norostat(auth = "auth_token") +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.meta_norostat('auth_token') +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index 70d3bb300..a9562cd06 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -6,18 +6,37 @@ nav_order: 2 --- # PAHO Dengue +{: .no_toc} -This is the documentation of the API for accessing the PAHO Dengue (`paho_dengue`) endpoint of -the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `paho_dengue` | +| **Data Source** | [Pan American Health Organization (PAHO) Dengue surveillance](https://www.paho.org/en/arbo-portal/dengue-data-and-analysis) | +| **Geographic Coverage** | Countries and territories in the Americas | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | + + + +## Overview +{: .no_toc} + +This data source provides weekly dengue case counts for countries and territories in the Americas, as reported by the Pan American Health Organization (PAHO). General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## PAHO Dengue Data +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + -... # The API @@ -29,21 +48,126 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required - +| Parameter | Description | Type | +| --- | --- | --- | +| `epiweeks` | epiweeks | `list` of epiweeks | +| `regions` | regions | `list` of region labels | ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|------------------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].release_date` | date when data was released | date (YYYY-MM-DD)| +| `epidata[].region` | region label (ISO 3166-1 alpha-2 code) | string | +| `epidata[].serotype` | dengue serotype information | string | +| `epidata[].issue` | epiweek when data was issued | integer | +| `epidata[].epiweek` | epiweek for the data point | integer | +| `epidata[].lag` | number of weeks between epiweek and issue | integer | +| `epidata[].total_pop` | total population (in thousands) | integer | +| `epidata[].num_dengue` | total number of dengue cases | integer | +| `epidata[].num_severe` | number of severe dengue cases | integer | +| `epidata[].num_deaths` | number of dengue-related deaths | integer | +| `epidata[].incidence_rate` | incidence rate per 100,000 population | float | +| `message` | `success` or error message | string | # Example URLs - +### PAHO Dengue on 2015w01 (Canada) +https://api.delphi.cmu.edu/epidata/paho_dengue/?regions=ca&epiweeks=201501 + +```json +{ + "result": 1, + "epidata": [ + { + "release_date": "2020-08-07", + "region": "CA", + "serotype": " ", + "issue": 202032, + "epiweek": 201501, + "lag": 291, + "total_pop": 0, + "num_dengue": 0, + "num_severe": 0, + "num_deaths": 0, + "incidence_rate": 0.0 + } + ], + "message": "success" +} +``` # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch PAHO Dengue data for Canada for epiweek `201501`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_paho_dengue(regions = 'ca', epiweeks = 201501) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_paho_dengue(regions=['ca'], epiweeks=[201501]) +print(res) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$paho_dengue(regions = list("ca"), epiweeks = list(201501)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.paho_dengue(['ca'], [201501]) +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/quidel.md b/docs/api/quidel.md index 28655e219..c58f79f19 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -6,14 +6,32 @@ nav_order: 2 --- # Quidel +{: .no_toc} -This is the documentation of the API for accessing the Quidel (`quidel`) endpoint of the Delphi’s epidemiological data. + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `quidel` | +| **Data Source** | Quidel influenza testing data | +| **Geographic Coverage** | HHS regions ([10 regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2015w35 (2015-08-30) | + + + +## Overview +{: .no_toc} + +This data source provides influenza testing data from Quidel Corporation, covering HHS health regions in the United States. General topics not specific to any particular endpoint are discussed in the [API overview](https://cmu-delphi.github.io/delphi-epidata/). Such topics include: [contributing](https://cmu-delphi.github.io/delphi-epidata/api/README.html#contributing), [citing](https://cmu-delphi.github.io/delphi-epidata/api/README.html#citing), and [data licensing](https://cmu-delphi.github.io/delphi-epidata/api/README.html#data-licensing). -## Quidel Data +## Table of contents +{: .no_toc .text-delta} -Data provided by Quidel Corp., which contains flu lab test results. +1. TOC +{:toc} ## The API @@ -33,9 +51,114 @@ See this [documentation](https://cmu-delphi.github.io/delphi-epidata/api/README. ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | \ No newline at end of file +| Field | Description | Type | +|-----------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].location` | HHS region label | string | +| `epidata[].epiweek` | epiweek for the data point | integer | +| `epidata[].value` | percentage of positive influenza tests | float | +| `message` | `success` or error message | string | + +# Example URLs + +### Quidel on 2015w35-2020w01 (HHS Region 1) +https://api.delphi.cmu.edu/epidata/quidel/?auth=...&locations=hhs1&epiweeks=201535-202001 + +```json +{ + "result": 1, + "epidata": [ + { + "location": "hhs1", + "epiweek": 201535, + "value": 2.0 + }, + { + "location": "hhs1", + "epiweek": 201536, + "value": 6.16667 + }, + ... + ], + "message": "success" +} +``` + +# Code Samples + +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch Quidel data for HHS Region 1 for epiweeks `201535-202001`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pvt_quidel(auth = 'auth_token', locations = 'hhs1', epiweeks = epirange(201535, 202001)) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pvt_quidel(auth='auth_token', locations=['hhs1'], epiweeks=EpiRange(201535, 202001)) +print(res) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$quidel(auth = "auth_token", locations = list("hhs1"), epiweeks = Epidata$range(201535, 202001)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.quidel('auth_token', ['hhs1'], Epidata.range(201535, 202001)) +print(res['result'], res['message'], len(res['epidata'])) +``` \ No newline at end of file diff --git a/docs/api/twitter.md b/docs/api/twitter.md index e14d940b6..d607ab7e6 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -6,22 +6,38 @@ nav_order: 2 --- # Twitter Stream +{: .no_toc} -This is the API documentation for accessing the Twitter Stream (`twitter`) -endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `twitter` | +| **Data Source** | [HealthTweets](http://www.healthtweets.org/) | +| **Geographic Coverage** | National, [HHS regions](http://www.hhs.gov/iea/regional/), [Census divisions](http://www.census.gov/econ/census/help/geography/regions_and_divisions.html) ([1+10+9](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)), and by state/territory ([51](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)) | +| **Temporal Resolution** | Daily and Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2011w48 (2011-11-27) | + + + +## Overview +{: .no_toc} + +Estimate of influenza activity based on analysis of language used in tweets. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Twitter Stream Data +## Table of contents +{: .no_toc .text-delta} -Estimate of influenza activity based on analysis of language used in tweets. - - Source: [HealthTweets](http://www.healthtweets.org/) - - Temporal Resolution: Daily and weekly from 2011-12-01 (2011w48) - - Spatial Resolution: National, [HHS regions](http://www.hhs.gov/iea/regional/), and [Census divisions](http://www.census.gov/econ/census/help/geography/regions_and_divisions.html) ([1+10+9](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)); and by state/territory ([51](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)) - - Restricted access: Delphi doesn't have permission to share this dataset +1. TOC +{:toc} + +{: .note} +> **Note:** Restricted access: Delphi doesn't have permission to share this dataset. # The API @@ -40,17 +56,22 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `dates` | dates | `list` of dates | | `epiweeks` | epiweeks | `list` of epiweeks | -Note: -- Only one of `dates` and `epiweeks` is required. If both are provided, `epiweeks` is ignored. +{: .note} +> **Note:** Only one of `dates` and `epiweeks` is required. If both are provided, `epiweeks` is ignored. ## Response -| Field | Description | Type | -|-----------|-----------------------------------------------------------------|------------------| -| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | -| `epidata` | list of results | array of objects | -| ... | ... | ... | -| `message` | `success` or error message | string | +| Field | Description | Type | +|-----------------------|-----------------------------------------------------------------|------------------| +| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | +| `epidata` | list of results | array of objects | +| `epidata[].location` | location label | string | +| `epidata[].date` | date (yyyy-MM-dd) | string | +| `epidata[].epiweek` | epiweek | integer | +| `epidata[].num` | number of tweets | integer | +| `epidata[].total` | total tweets | integer | +| `epidata[].percent` | percent of tweets | float | +| `message` | `success` or error message | string | # Example URLs @@ -59,9 +80,17 @@ https://api.delphi.cmu.edu/epidata/twitter/?auth=...&locations=nat&epiweeks=2015 ```json { - "result":1, - "epidata":[...], - "message":"success" + "result": 1, + "epidata": [ + { + "location": "nat", + "num": 3067, + "total": 443291, + "epiweek": 201501, + "percent": 0.6919 + } + ], + "message": "success" } ``` # Citing the Survey @@ -70,8 +99,83 @@ Researchers who use the Twitter Stream data for research are asked to credit and > Mark Dredze, Renyuan Cheng, Michael J Paul, David A Broniatowski. HealthTweets.org: A Platform for Public Health Surveillance using Twitter. AAAI Workshop on the World Wide Web and Public Health > Intelligence, 2014. - + # Code Samples - +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch Twitter data for national level for epiweek `201501`. + +### R + +```R +library(epidatr) +# Fetch data +res <- pvt_twitter(auth = 'auth_token', locations = 'nat', + time_type = "week", time_values = 201501) +print(res) +``` + +### Python + +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pvt_twitter(auth='auth_token', locations=['nat'], time_type="week", time_values=[201501]) +print(res) +``` + +### JavaScript (in a web browser) + +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` + +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$twitter(auth = "auth_token", locations = list("nat"), time_type = "week", time_values = list(201501)) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) + +Optionally install the package using pip(env): +```bash +pip install delphi-epidata +``` + +Otherwise, place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.twitter('auth_token', ['nat'], time_type="week", time_values=[201501]) +print(res['result'], res['message'], len(res['epidata'])) +``` diff --git a/docs/api/wiki.md b/docs/api/wiki.md index ba780ea6f..09f5c39ab 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -6,23 +6,37 @@ nav_order: 2 --- # Wikipedia Access +{: .no_toc} -This is the API documentation for accessing the Wikipedia Access (`wiki`) -endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `wiki` | +| **Data Source** | [Wikimedia pageviews](https://dumps.wikimedia.org/other/pagecounts-raw/) for health-related Wikipedia articles | +| **Dataset Type** | Surveillance (Inactive) | +| **Geographic Coverage** | Not applicable (article-based) | +| **Temporal Resolution** | Hourly, Daily, and Weekly (Epiweek) | +| **Available Articles** | [54 health-related articles](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/articles.txt) | +| **Update Frequency** | Inactive - No longer updated | +| **License** | Open Access | + + + +## Overview +{: .no_toc} + +This data source provides pageview counts for Influenza-related Wikipedia articles, which can serve as indicators of public health interest and awareness. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Wikipedia Access Data +## Table of contents +{: .no_toc .text-delta} -Number of page visits for selected English, Influenza-related wikipedia articles. - - Source: [Wikimedia](https://dumps.wikimedia.org/other/pagecounts-raw/) - - Temporal Resolution: Hourly, daily, and weekly from 2007-12-09 (2007w50) - - Spatial Resolution: N/A - - Other resolution: By article ([54](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/articles.txt)) - - Open access +1. TOC +{:toc} # The API @@ -41,8 +55,6 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `dates` | dates | `list` of dates | | `epiweeks` | epiweeks | `list` of epiweeks | -Note: -- Only one of `dates` and `epiweeks` is required. If both are provided, `epiweeks` is ignored. ### Optional @@ -50,19 +62,25 @@ Note: |-----------|-------------|------------------------| | `hours` | hours | `list` of hours (0-23) | +{: .note} +> **Notes:** +> - Only one of `dates` and `epiweeks` is required. If both are provided, `epiweeks` is ignored. +> - `dates`, `epiweeks`, and `hours` are `None` by default. +> - `language` is `en` by default. + ## Response | Field | Description | Type | |---------------------|-----------------------------------------------------------------|------------------| | `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | | `epidata` | list of results | array of objects | -| `epidata[].article` | | string | -| `epidata[].count` | | integer | -| `epidata[].total` | | integer | -| `epidata[].hour` | hour (-1 if `hour` not used) | integer | +| `epidata[].article` | Wikipedia article name | string | +| `epidata[].count` | number of pageviews | integer | +| `epidata[].total` | total pageviews | integer | +| `epidata[].hour` | hour (-1 if `hour` not used) | integer | | `epidata[].date` | date (yyyy-MM-dd) (only included if `date` used) | string | | `epidata[].epiweek` | epiweek (only included if `epiweek` used) | integer | -| `epidata[].value` | | float | +| `epidata[].value` | normalized pageview count | float | | `message` | `success` or error message | string | # Example URLs @@ -109,52 +127,79 @@ https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&dates=20 # Code Samples -Libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -The following samples show how to import the library and fetch national Wikipedia Access data for article "influenza" on -epiweeks `201940` and `202001-202010` (11 weeks total) for hours 0 and 12 in English. +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch Wikipedia Access data for article "influenza" in English for epiweeks `202001-202010` (10 weeks total) and hours 0 and 12. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_wiki(articles = "influenza", time_values = epirange(202001, 202010), + time_type = "week", language = "en", hours = c(0, 12)) +print(res) +``` + +### Python - +Install the package using pip: +```bash +pip install -e "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +```python +# Import +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_wiki(articles=['influenza'], time_values=EpiRange(202001, 202010), time_type='week', language='en', hours=[0, 12]) +print(res) +``` ### JavaScript (in a web browser) -````html +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html -```` +``` -### Python +### Legacy Clients + +We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +#### R (Legacy) + +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$wiki(articles = list("influenza"), time_values = Epidata$range(202001, 202010), time_type = "week", options = list(language = "en", hours = list(0, 12))) +print(res$message) +print(length(res$epidata)) +``` + +#### Python (Legacy) Optionally install the package using pip(env): -````bash +```bash pip install delphi-epidata -```` +``` Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data -res = Epidata.wiki(['influenza'], None, [201940, Epidata.range(202001, 202010)], [0, 12]) +res = Epidata.wiki(['influenza'], Epidata.range(202001, 202010), {'time_type': 'week', 'language': 'en', 'hours': [0, 12]}) print(res['result'], res['message'], len(res['epidata'])) -```` - -Note: -- `dates`, `epiweeks`, and `hours` are `None` by default. -- `language` is `en` by default. - -### R - -````R -# Import -source('delphi_epidata.R') -# Fetch data -res <- Epidata$wiki(list('nat'), NULL, list(201940, Epidata$range(202001, 202010)), list(0, 12), 'en') -cat(paste(res$result, res$message, length(res$epidata), "\n")) -```` +``` From b5f61c3368ea6a1055a2577c8a6157cf1a3592b4 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Wed, 26 Nov 2025 00:31:58 -0800 Subject: [PATCH 33/64] docs: add geographic reference to other endpoints. --- docs/api/cdc.md | 2 +- docs/api/covid_hosp.md | 2 +- docs/api/covid_hosp_facility_lookup.md | 2 +- docs/api/digital_surveillance_sensors.md | 12 +- docs/api/ecdc_ili.md | 4 +- docs/api/flusurv.md | 4 +- docs/api/fluview.md | 10 +- docs/api/fluview_clinical.md | 4 +- docs/api/geographic_codes.md | 427 +++++++++++++++++++++++ docs/api/gft.md | 4 +- docs/api/ght.md | 20 +- docs/api/ili_nearby_nowcast.md | 4 +- docs/api/kcdc_ili.md | 18 +- docs/api/nidss_dengue.md | 5 +- docs/api/nidss_flu.md | 4 +- docs/api/paho_dengue.md | 4 +- docs/api/quidel.md | 4 +- docs/api/twitter.md | 4 +- 18 files changed, 480 insertions(+), 54 deletions(-) create mode 100644 docs/api/geographic_codes.md diff --git a/docs/api/cdc.md b/docs/api/cdc.md index 0b3e31a19..616c028f0 100644 --- a/docs/api/cdc.md +++ b/docs/api/cdc.md @@ -13,7 +13,7 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `cdc` | | **Data Source** | CDC influenza surveillance data | -| **Geographic Coverage** | National, HHS regions, Census divisions, and US states | +| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Inactive - No longer updated | | **Earliest Date** | 2013w02 (2013-01-06) | diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md index 584054da3..6ae18c98f 100644 --- a/docs/api/covid_hosp.md +++ b/docs/api/covid_hosp.md @@ -12,7 +12,7 @@ nav_order: 2 * **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) * **Earliest issue available:** 2020-01-01 * **Temporal Resolution:** Daily -* **Spatial Resolution:** US States plus DC, PR, and VI +* **Spatial Resolution:** US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) * **License:** [Public Domain US Government](https://www.usa.gov/government-works) ## Overview diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md index d15b9273f..657414859 100644 --- a/docs/api/covid_hosp_facility_lookup.md +++ b/docs/api/covid_hosp_facility_lookup.md @@ -44,7 +44,7 @@ See [this documentation](README.md) for details on specifying locations and date | Parameter | Description | Type | |-------------|-----------------------------------|--------| -| `state` | two-letter state abbreviation | string | +| `state` | two-letter state abbreviation (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | string | | `ccn` | facility CMS Certification Number | string | | `city` | city name | string | | `zip` | 5-digit ZIP code | string | diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index 36f2fdf83..155652900 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -16,7 +16,8 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -**Note:** this repository was built to support modeling and forecasting efforts +{: .note} +> **Note:** this repository was built to support modelling and forecasting efforts surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic, syndromic surveillance data, like ILI data (influenza-like illness) through FluView, will likely prove very useful. However, **we urge caution to users @@ -39,12 +40,13 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)/[state](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt) labels | +| `locations` | locations | `list` of location codes: `nat`, HHS regions, Census divisions, or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | `names` | sensor names | `list` of string | -Notes: -* Names of open sensors (no `auth` token required): `sar3`, `epic`, `arch` -* Names of sensors requiring `auth` token: `twtr`, `gft`, `ght`, `ghtj`, `cdc`, `quid`, `wiki` +{: .note} +> **Notes:** +> * Names of open sensors (no `auth` token required): `sar3`, `epic`, `arch` +> * Names of sensors requiring `auth` token: `twtr`, `gft`, `ght`, `ghtj`, `cdc`, `quid`, `wiki` ### Optional diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index b88cf886e..498e514fc 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -10,7 +10,7 @@ nav_order: 2 * **Source name:** `ecdc_ili` * **Earliest issue available:** 2003w40 -* **Regions available:** European countries ([full list](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/ecdc_regions.txt)) +* **Regions available:** European countries (see [Geographic Codes](geographic_codes.html#european-countries)) * **Time type available:** epiweek * **License:** Open access @@ -50,7 +50,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/ecdc_regions.txt) labels | +| `regions` | regions | `list` of European country labels (see [Geographic Codes](geographic_codes.html#european-countries)) | ### Optional diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index 6672757fe..265f98d13 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -11,7 +11,7 @@ nav_order: 2 * **Source name:** `flusurv` * **Earliest issue available:** 2009w40 * **Data source:** [Laboratory-Confirmed Influenza Hospitalizations](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html) -* **Location available:** CA, CO, CT, GA, IA, ID, MD, MI, MN, NM, NY_albany, NY_rochester, OH, OK, OR, RI, SD, TN, UT, network_all, network_eip, network_ihsp ([full list of locations](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/flusurv_locations.txt)) +* **Location available:** See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list * **Time type available:** epiweek @@ -53,7 +53,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of [location](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/flusurv_locations.txt) labels | +| `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#flusurv-locations)) | ### Optional diff --git a/docs/api/fluview.md b/docs/api/fluview.md index 0ff327abd..c362f6dfd 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -12,7 +12,7 @@ nav_order: 1 * **Data source:** [United States Centers for Disease Control and Prevention](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) (CDC) * **Earliest issue available:** 1997w40 * **Date of last change:** [Weekly (typically Fridays)] -* **Available for:** nat, hhs1-hhs10, and cen1-cen9 ([full list of regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)) +* **Available for:** nat, hhs1-hhs10, and cen1-cen9 (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) * **Time type available:** epiweek * **License:** Open Access / [CDC](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) @@ -36,7 +36,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt) labels | +| `regions` | regions | `list` of region labels: `nat`, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ### Optional @@ -46,9 +46,9 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `lag` | # weeks between each epiweek and its issue | integer | | `auth` | password for private imputed data | string | -Notes: -- If both `issues` and `lag` are specified, only `issues` is used. -If neither is specified, the current issues are used. +> **Notes:** +> - If both `issues` and `lag` are specified, only `issues` is used. +> - If neither is specified, the current issues are used. ## Response diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index 6b6d2a633..b9b52932e 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -10,7 +10,7 @@ nav_order: 1 * **Source name:** `fluview_clinical` * **Earliest issue available:** 2010w40 -* **Available for:** nat, hhs1-hhs10, and cen1-cen9 ([full list of regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)) +* **Available for:** nat, hhs1-hhs10, and cen1-cen9 (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) * **Time type available:** epiweek * **License:** Open Access @@ -46,7 +46,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt) labels | +| `regions` | regions | `list` of region labels: `nat`, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ### Optional diff --git a/docs/api/geographic_codes.md b/docs/api/geographic_codes.md new file mode 100644 index 000000000..4f3cad2a2 --- /dev/null +++ b/docs/api/geographic_codes.md @@ -0,0 +1,427 @@ +--- +title: Geographic Codes +parent: Other Endpoints (COVID-19 and Other Diseases) +nav_order: 100 +--- + +# Geographic Codes +{: .no_toc} + +This page documents the valid geographic codes accepted by various API endpoints. + +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + +## PAHO Dengue + +The [PAHO Dengue](paho_dengue.html) endpoint accepts ISO 3166-1 alpha-2 country codes for countries and territories in the Americas. + +### Supported Region Codes + +| Code | Name | +|---|---| +| AG | Antigua and Barbuda | +| AI | Anguilla | +| AR | Argentina | +| AW | Aruba | +| BB | Barbados | +| BL | Saint Barthelemy | +| BM | Bermuda | +| BO | Bolivia | +| BQ | Bonaire, Saint Eustatius and Saba | +| BR | Brazil | +| BS | Bahamas | +| BZ | Belize | +| CA | Canada | +| CL | Chile | +| CO | Colombia | +| CR | Costa Rica | +| CU | Cuba | +| CW | Curaçao | +| DO | Dominican Republic | +| EC | Ecuador | +| GD | Grenada | +| GF | French Guiana | +| GP | Guadeloupe | +| GT | Guatemala | +| GY | Guyana | +| HN | Honduras | +| HT | Haiti | +| JM | Jamaica | +| KN | Saint Kitts and Nevis | +| KY | Cayman Islands | +| LC | Saint Lucia | +| MF | Saint Martin (French part) | +| MQ | Martinique | +| MS | Montserrat | +| MX | Mexico | +| NI | Nicaragua | +| PA | Panama | +| PE | Peru | +| PR | Puerto Rico | +| PY | Paraguay | +| SR | Suriname | +| SV | El Salvador | +| SX | Sint Maarten (Dutch part) | +| TC | Turks and Caicos Islands | +| TT | Trinidad and Tobago | +| US | United States of America | +| UY | Uruguay | +| VC | Saint Vincent and the Grenadines | +| VG | Virgin Islands (UK) | +| VI | Virgin Islands (US) | + + +## US Regions and States + +Multiple endpoints use standard US geographic codes. These include the national code, HHS regions, Census divisions, and state codes. + +### National Code + +| Code | Name | +|---|---| +| nat | United States (National) | + +### HHS Regions + +The US Department of Health and Human Services divides the country into 10 regions. + +| Code | Region | States | +|---|---|---| +| hhs1 | Region 1 | CT, ME, MA, NH, RI, VT | +| hhs2 | Region 2 | NJ, NY, PR, VI | +| hhs3 | Region 3 | DE, DC, MD, PA, VA, WV | +| hhs4 | Region 4 | AL, FL, GA, KY, MS, NC, SC, TN | +| hhs5 | Region 5 | IL, IN, MI, MN, OH, WI | +| hhs6 | Region 6 | AR, LA, NM, OK, TX | +| hhs7 | Region 7 | IA, KS, MO, NE | +| hhs8 | Region 8 | CO, MT, ND, SD, UT, WY | +| hhs9 | Region 9 | AZ, CA, HI, NV, AS, GU, MP | +| hhs10 | Region 10 | AK, ID, OR, WA | + +### Census Divisions + +The US Census Bureau divides the country into 9 divisions. + +| Code | Division | States | +|---|---|---| +| cen1 | New England | CT, ME, MA, NH, RI, VT | +| cen2 | Mid-Atlantic | NJ, NY, PA | +| cen3 | East North Central | IL, IN, MI, OH, WI | +| cen4 | West North Central | IA, KS, MN, MO, NE, ND, SD | +| cen5 | South Atlantic | DE, DC, FL, GA, MD, NC, SC, VA, WV | +| cen6 | East South Central | AL, KY, MS, TN | +| cen7 | West South Central | AR, LA, OK, TX | +| cen8 | Mountain | AZ, CO, ID, MT, NV, NM, UT, WY | +| cen9 | Pacific | AK, CA, HI, OR, WA | + +### US States and Territories + +Full list of 51 US states and territories used by multiple endpoints: + +| Code | Name | +|---|---| +| AK | Alaska | +| AL | Alabama | +| AR | Arkansas | +| AZ | Arizona | +| CA | California | +| CO | Colorado | +| CT | Connecticut | +| DC | District of Columbia | +| DE | Delaware | +| FL | Florida | +| GA | Georgia | +| HI | Hawaii | +| IA | Iowa | +| ID | Idaho | +| IL | Illinois | +| IN | Indiana | +| KS | Kansas | +| KY | Kentucky | +| LA | Louisiana | +| MA | Massachusetts | +| MD | Maryland | +| ME | Maine | +| MI | Michigan | +| MN | Minnesota | +| MO | Missouri | +| MS | Mississippi | +| MT | Montana | +| NC | North Carolina | +| ND | North Dakota | +| NE | Nebraska | +| NH | New Hampshire | +| NJ | New Jersey | +| NM | New Mexico | +| NV | Nevada | +| NY | New York | +| OH | Ohio | +| OK | Oklahoma | +| OR | Oregon | +| PA | Pennsylvania | +| RI | Rhode Island | +| SC | South Carolina | +| SD | South Dakota | +| TN | Tennessee | +| TX | Texas | +| UT | Utah | +| VA | Virginia | +| VT | Vermont | +| WA | Washington | +| WI | Wisconsin | +| WV | West Virginia | +| WY | Wyoming | + +## Selected US cities + +Selected US cities used by multiple endpoints. + +| Code | +|---| +| Abilene_TX | +| Akron_OH | +| Albany_NY | +| Albuquerque_NM | +| Alexandria_VA | +| Allentown_PA | +| Amarillo_TX | +| Anaheim_CA | +| Anchorage_AK | +| Ann_Arbor_MI | +| Arlington_TX | +| Arlington_VA | +| Atlanta_GA | +| Austin_TX | +| Bakersfield_CA | +| Baltimore_MD | +| Baton_Rouge_LA | +| Berkeley_CA | +| Birmingham_AL | +| Boise_ID | +| Boston_MA | +| Boulder_CO | +| Buffalo_NY | +| Cary_NC | +| Charlotte_NC | +| Chicago_IL | +| Cleveland_OH | +| Colorado_Springs_CO | +| Columbia_SC | +| Columbus_OH | +| Dallas_TX | +| Dayton_OH | +| Denver_CO | +| Des_Moines_IA | +| Durham_NC | +| Eugene_OR | +| Fresno_CA | +| Ft_Worth_TX | +| Gainesville_FL | +| Grand_Rapids_MI | +| Greensboro_NC | +| Greenville_SC | +| Honolulu_HI | +| Houston_TX | +| Indianapolis_IN | +| Irvine_CA | +| Irving_TX | +| Jacksonville_FL | +| Jackson_MS | +| Kansas_City_MO | +| Knoxville_TN | +| Las_Vegas_NV | +| Lexington_KY | +| Lincoln_NE | +| Little_Rock_AR | +| Los_Angeles_CA | +| Lubbock_TX | +| Madison_WI | +| Memphis_TN | +| Mesa_AZ | +| Miami_FL | +| Milwaukee_WI | +| Nashville_TN | +| Newark_NJ | +| New_Orleans_LA | +| New_York_NY | +| Norfolk_VA | +| Oakland_CA | +| Oklahoma_City_OK | +| Omaha_NE | +| Orlando_FL | +| Philadelphia_PA | +| Phoenix_AZ | +| Pittsburgh_PA | +| Plano_TX | +| Portland_OR | +| Providence_RI | +| Raleigh_NC | +| Reno_NV | +| Reston_VA | +| Richmond_VA | +| Rochester_NY | +| Roswell_GA | +| Sacramento_CA | +| Salt_Lake_City_UT | +| Santa_Clara_CA | +| San_Antonio_TX | +| San_Diego_CA | +| San_Francisco_CA | +| San_Jose_CA | +| Scottsdale_AZ | +| Seattle_WA | +| Somerville_MA | +| Spokane_WA | +| Springfield_MO | +| State_College_PA | +| St_Louis_MO | +| St_Paul_MN | +| Sunnyvale_CA | +| Tampa_FL | +| Tempe_AZ | +| Tucson_AZ | +| Tulsa_OK | +| Washington_DC | +| Wichita_KS | + +## NIDSS + +Geographic codes used by [NIDSS Flu](nidss_flu.html) and [NIDSS Dengue](nidss_dengue.html) endpoints. + +### Taiwan Regions + +Regions of Taiwan. + +| Code | +|---| +| nationwide | +| central | +| eastern | +| kaoping | +| northern | +| southern | +| taipei | + +### Taiwan Cities and Counties + +Administrative divisions of Taiwan. + +| Code | +|---| +| changhua_county | +| chiayi_city | +| chiayi_county | +| hsinchu_city | +| hsinchu_county | +| hualien_county | +| kaohsiung_city | +| keelung_city | +| kinmen_county | +| lienchiang_county | +| miaoli_county | +| nantou_county | +| new_taipei_city | +| penghu_county | +| pingtung_county | +| taichung_city | +| tainan_city | +| taipei_city | +| taitung_county | +| taoyuan_city | +| yilan_county | +| yunlin_county | + +## European Countries + +European countries and regions used by the [ECDC ILI](ecdc_ili.html) endpoint. + +| Name | +|---| +| Armenia | +| Austria | +| Azerbaijan | +| Belarus | +| Belgium | +| Czech Republic | +| Denmark | +| Estonia | +| Finland | +| France | +| Georgia | +| Iceland | +| Ireland | +| Israel | +| Italy | +| Kazakhstan | +| Kosovo* | +| Kyrgyzstan | +| Latvia | +| Lithuania | +| Luxembourg | +| Malta | +| Moldova | +| Montenegro | +| Netherlands | +| North Macedonia | +| Norway | +| Poland | +| Portugal | +| Romania | +| Russia | +| Serbia | +| Slovakia | +| Slovenia | +| Spain | +| Switzerland | +| Tajikistan | +| Turkey | +| Turkmenistan | +| Ukraine | +| United Kingdom - England | +| United Kingdom - Northern Irel | +| United Kingdom - Scotland | +| United Kingdom - Wales | +| Uzbekistan | + +## FluSurv Locations + +Locations used by the [FluSurv](flusurv.html) endpoint. + +| Code | Description | +|---|---| +| CA | California | +| CO | Colorado | +| CT | Connecticut | +| GA | Georgia | +| IA | Iowa | +| ID | Idaho | +| MD | Maryland | +| MI | Michigan | +| MN | Minnesota | +| NM | New Mexico | +| NY_albany | New York (Albany) | +| NY_rochester | New York (Rochester) | +| OH | Ohio | +| OK | Oklahoma | +| OR | Oregon | +| RI | Rhode Island | +| SD | South Dakota | +| TN | Tennessee | +| UT | Utah | +| network_all | All Networks | +| network_eip | Emerging Infections Program | +| network_ihsp | Influenza Hospitalization Surveillance Project | + +## Republic of Korea + +Geographic codes used by the [KCDC ILI](kcdc_ili.html) endpoint. + +| Code | Name | +|---|---| +| ROK | Republic of Korea | + + diff --git a/docs/api/gft.md b/docs/api/gft.md index 92fc6afd6..030d074d4 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -13,7 +13,7 @@ nav_order: 2 * **Earliest issue available:** 2003w40 * **Available for:** US states, census regions, and select cities ([regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt), [states](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt), [cities](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/cities.txt)) * **Temporal Resolution:** Weekly -* **Spatial Resolution:** National, [HHS regions](http://www.hhs.gov/iea/regional/) ([1+10](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)); by state/territory ([50+1](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)); and by city ([97](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/cities.txt)) +* **Spatial Resolution:** National, HHS regions, US states (see [US Regions and States](geographic_codes.html#us-regions-and-states)), and select cities (see [Selected US Cities](geographic_codes.html#selected-us-cities)) * **License:** Open access @@ -48,7 +48,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `locations` | Locations to fetch. | `list` of strings | +| `locations` | Locations to fetch. National, HHS regions, US states (see [US Regions and States](geographic_codes.html#us-regions-and-states)), and select cities (see [Selected US Cities](geographic_codes.html#selected-us-cities)). | `list` of strings | | `epiweeks` | Epiweeks to fetch. Supports [`epirange()`] and defaults to all ("*") dates. | `list` of epiweeks | ## Response diff --git a/docs/api/ght.md b/docs/api/ght.md index ef2cf8851..0ba634885 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -10,11 +10,11 @@ nav_order: 2 * **Source name:** `ght` * **Earliest issue available:** 2003w40 -* **Available for:** US states([states list](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)) and national level (US) +* **Available for:** [US States](geographic_codes.html#us-states-and-territories) and national level (US) * **Time type available:** epiweek * **License:** Restricted (requires auth) -This is the API documentation for accessing the [Google Health Trends](https://trends.google.com/trends/fullscreen/m/IN) (`ght`) +This is the API documentation for accessing the Google Health Trends (`ght`) endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. General topics not specific to any particular endpoint are discussed in the @@ -22,19 +22,19 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Table of contents -{: .no_toc .text-delta} - -1. TOC -{:toc} - - +This data may be useful for real-time monitoring of diseases, as in: - Herman Anthony Carneiro, Eleftherios Mylonakis. [Google Trends: A Web-Based Tool for Real-Time Surveillance of Disease Outbreaks](https://doi.org/10.1086/630200). Clinical Infectious Diseases, Volume 49, Issue 10, 15 November 2009, Pages 1557–1564. - Abel Brodeur, Andrew E. Clark, Sarah Fleche, Nattavudh Powdthavee. [COVID-19, lockdowns and well-being: Evidence from Google Trends](https://doi.org/10.1016/j.jpubeco.2020.104346). Journal of Public Economics, Volume 193, 2021, 104346. - Sudhakar V. Nuti, Brian Wayda, Isuru Ranasinghe, Sisi Wang, Rachel P. Dreyer, Serene I. Chen, Karthik Murugiah. [The Use of Google Trends in Health Care Research: A Systematic Review](https://doi.org/10.1371/journal.pone.0109583), October 2014. +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + # The API The base URL is: https://api.delphi.cmu.edu/epidata/ght/ @@ -49,7 +49,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | --- | --- | --- | | `auth` | password | string | | `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of [state](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt) and/or `US` labels | +| `locations` | locations | `list` of state codes (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) and/or `US` | | `query` | search query or topic ID (see https://www.freebase.com/) | string | ## Response diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index 066f70e0e..84d539252 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -15,7 +15,7 @@ permalink: api/nowcast.html | **Source Name** | `nowcast` | | **Data Source:** | [Delphi's ILI Nearby system](https://delphi.cmu.edu/nowcast/) | **Dataset Type** | Predictive (Leading Indicator) | -| **Geographic Coverage** | National, [HHS regions](http://www.hhs.gov/iea/regional/), [Census divisions](http://www.census.gov/econ/census/help/geography/regions_and_divisions.html) ([1+10+9](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)), and by state/territory ([51](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt) | +| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Released Friday; updated Sunday & Monday | | **Earliest Date** | 2010w30 | @@ -55,7 +55,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)/[state](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt) labels | +| `locations` | locations | `list` of location codes: `nat`, HHS regions, Census divisions, or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ## Response diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index 3645c9e51..604b53ee9 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -12,8 +12,8 @@ nav_order: 2 | Attribute | Details | | :--- | :--- | | **Source Name** | `kcdc_ili` | -| **Data Source:** | [KCDC](https://www.kdca.go.kr/) (Korea Disease Control and Prevention Agency) ILI surveillance | -| **Geographic Coverage** | ROK (Republic of Korea) | +| **Data Source:** | [Korea Disease Control and Prevention Agency (KCDC) ILI surveillance](https://www.kdca.go.kr/) | +| **Geographic Coverage** | ROK (Republic of Korea) (see [Geographic Codes](geographic_codes.md#republic-of-korea)) | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Inactive - No longer updated | | **Earliest Date** | 2004w36 | @@ -39,7 +39,6 @@ General topics not specific to any particular endpoint are discussed in the {:toc} - # The API The base URL is: https://api.delphi.cmu.edu/epidata/kcdc_ili/ @@ -50,13 +49,9 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required -## Parameters - -### Required - | Parameter | Description | Type | | --- | --- | --- | -| `regions` | Regions to fetch. | `list` of strings | +| `regions` | Regions to fetch. See [Geographic Codes](geographic_codes.html#republic-of-korea). | `list` of strings | | `epiweeks` | Epiweeks to fetch. Supports [`epirange()`] and defaults to all ("*") dates. | `list` of epiweeks | ### Optional @@ -66,9 +61,10 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `issues` | Optionally, the issue(s) of the data to fetch. See the "Data Versioning" section for details. | `list` of epiweeks | | `lag` | Optionally, the lag of the issues to fetch. See the "Data Versioning" section for details. | integer | -Notes: -- If both `issues` and `lag` are specified, only `issues` is used. -If neither is specified, the current issues are used. +{: .note} +> **Notes:** +> - If both `issues` and `lag` are specified, only `issues` is used. +> - If neither is specified, the current issues are used. ## Response diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 91ef8fe85..877c198cb 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -13,7 +13,7 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `nidss_dengue` | | **Data Source** | [Taiwan CDC](http://nidss.cdc.gov.tw/en/SingleDisease.aspx?dc=1&dt=4&disease=061&position=1)| -| **Geographic Coverage** | [hexchotomy region](https://en.wikipedia.org/wiki/Regions_of_Taiwan#Hexchotomy) ([6+1](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt)) and [city/county](https://en.wikipedia.org/wiki/List_of_administrative_divisions_of_Taiwan) ([22](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_locations.txt)) | +| **Geographic Coverage** | Taiwan regions and cities/counties (see [Geographic Codes](geographic_codes.html#nidss)) | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Inactive - No longer updated | | **Earliest Date** | 2003w01 | @@ -50,7 +50,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt) and/or [location](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_locations.txt) labels | +| `locations` | locations | `list` of Taiwan region and/or location labels (see [Geographic Codes](geographic_codes.html#nidss)) | ## Response @@ -163,4 +163,5 @@ print(res['result'], res['message'], len(res['epidata'])) # Source and Licensing +The full text of the NIDSS Dengue license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license). The full text of the NIDSS Dengue license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license). \ No newline at end of file diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index ffabba5ad..72ed231bc 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -13,7 +13,7 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `nidss_flu` | | **Source** | [Taiwan CDC](http://nidss.cdc.gov.tw/en/CDCWNH01.aspx?dc=wnh) | -| **Geographic Coverage** | [hexchotomy region](https://en.wikipedia.org/wiki/Regions_of_Taiwan#Hexchotomy) ([6+1](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt)) | +| **Geographic Coverage** | Taiwan regions (see [Geographic Codes](geographic_codes.html#taiwan-regions)) | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Inactive - No longer updated | | **Earliest Date** | 2008w14 | @@ -51,7 +51,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt) labels | +| `regions` | regions | `list` of Taiwan region labels (see [Geographic Codes](geographic_codes.html#taiwan-regions)) | ### Optional diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index a9562cd06..cee15c266 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -13,7 +13,7 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `paho_dengue` | | **Data Source** | [Pan American Health Organization (PAHO) Dengue surveillance](https://www.paho.org/en/arbo-portal/dengue-data-and-analysis) | -| **Geographic Coverage** | Countries and territories in the Americas | +| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#paho-dengue)) | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Inactive - No longer updated | @@ -51,7 +51,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `regions` | regions | `list` of region labels | +| `regions` | regions | `list` of region labels (see [Geographic Codes](geographic_codes.html#paho-dengue)) | ## Response diff --git a/docs/api/quidel.md b/docs/api/quidel.md index c58f79f19..51898687b 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -13,7 +13,7 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `quidel` | | **Data Source** | Quidel influenza testing data | -| **Geographic Coverage** | HHS regions ([10 regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)) | +| **Geographic Coverage** | HHS regions (see [Geographic Codes](geographic_codes.html#hhs-regions)) | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Inactive - No longer updated | | **Earliest Date** | 2015w35 (2015-08-30) | @@ -47,7 +47,7 @@ See this [documentation](https://cmu-delphi.github.io/delphi-epidata/api/README. | --- | --- | --- | | `auth` | password | string | | `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of `hhs<#>` [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt) labels | +| `locations` | locations | `list` of `hhs<#>` region labels (see [Geographic Codes](geographic_codes.html#hhs-regions)) | ## Response diff --git a/docs/api/twitter.md b/docs/api/twitter.md index d607ab7e6..f0d2e8b20 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -13,7 +13,7 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `twitter` | | **Data Source** | [HealthTweets](http://www.healthtweets.org/) | -| **Geographic Coverage** | National, [HHS regions](http://www.hhs.gov/iea/regional/), [Census divisions](http://www.census.gov/econ/census/help/geography/regions_and_divisions.html) ([1+10+9](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)), and by state/territory ([51](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt)) | +| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Resolution** | Daily and Weekly (Epiweek) | | **Update Frequency** | Inactive - No longer updated | | **Earliest Date** | 2011w48 (2011-11-27) | @@ -52,7 +52,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `auth` | password | string | -| `locations` | locations | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt)/[state](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt) labels | +| `locations` | locations | `list` of location codes: `nat`, HHS regions, Census divisions, or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | `dates` | dates | `list` of dates | | `epiweeks` | epiweeks | `list` of epiweeks | From 7830d5a4b2946f15d8d27d57e94c240c047c121a Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Wed, 26 Nov 2025 14:15:29 -0800 Subject: [PATCH 34/64] docs: standardize header for Other Endpoints --- docs/api/covid_hosp.md | 18 ++++++---- docs/api/covid_hosp_facility.md | 30 +++++++++------- docs/api/covid_hosp_facility_lookup.md | 24 +++++++++---- docs/api/delphi.md | 37 +++++++++++++------- docs/api/dengue_digital_surveillance.md | 19 ++++++---- docs/api/dengue_nowcast.md | 17 +++++---- docs/api/digital_surveillance_sensors.md | 26 +++++++++----- docs/api/ecdc_ili.md | 26 +++++++------- docs/api/flusurv.md | 37 ++++++++++++-------- docs/api/fluview.md | 25 ++++++++------ docs/api/fluview_clinical.md | 44 +++++++++++++----------- docs/api/fluview_meta.md | 33 ++++++++++++++++++ docs/api/geographic_codes.md | 30 ++++++++++++++-- docs/api/gft.md | 25 +++++++------- docs/api/ght.md | 18 ++++++---- docs/api/ili_nearby_nowcast.md | 4 +-- docs/api/kcdc_ili.md | 2 +- docs/api/norostat.md | 2 +- docs/api/paho_dengue.md | 6 ++-- 19 files changed, 276 insertions(+), 147 deletions(-) diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md index 6ae18c98f..744e82946 100644 --- a/docs/api/covid_hosp.md +++ b/docs/api/covid_hosp.md @@ -8,12 +8,16 @@ nav_order: 2 # COVID-19 Hospitalization by State {: .no_toc} -* **Source name:** `covid_hosp_state_timeseries` -* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) -* **Earliest issue available:** 2020-01-01 -* **Temporal Resolution:** Daily -* **Spatial Resolution:** US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) -* **License:** [Public Domain US Government](https://www.usa.gov/government-works) + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `covid_hosp_state_timeseries` | +| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) | +| **Geographic Coverage** | US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | +| **Temporal Resolution** | Daily | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2020-01-01 | +| **License** | [Public Domain US Government](https://www.usa.gov/government-works) | ## Overview {: .no_toc} @@ -59,7 +63,7 @@ See [this documentation](README.md) for details on specifying locations and date | Parameter | Description | Type | |-----------|--------------------------------|--------------------------------| -| `states` | two-letter state abbreviations | `list` of states | +| `states` | two-letter state abbreviations (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | `list` of states | | `dates` | dates | `list` of dates or date ranges | ### Optional diff --git a/docs/api/covid_hosp_facility.md b/docs/api/covid_hosp_facility.md index d3ca9c5d1..9f9e39e93 100644 --- a/docs/api/covid_hosp_facility.md +++ b/docs/api/covid_hosp_facility.md @@ -8,12 +8,16 @@ nav_order: 2 # COVID-19 Hospitalization by Facility {: .no_toc} -* **Source name:** `covid_hosp_facility` -* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) -* **Earliest issue available:** 2020-07-31 -* **Geographic resolution:** healthcare facility (address, city, zip, fips) -* **Temporal resolution:** weekly (Friday -- Thursday) -* **License:** [Public Domain US Government](https://www.usa.gov/government-works) + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `covid_hosp_facility` | +| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) | +| **Geographic Coverage** | Healthcare facility | +| **Temporal Resolution** | Weekly (Friday -- Thursday) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2020-07-31 | +| **License** | [Public Domain US Government](https://www.usa.gov/government-works) | ## Overview {: .no_toc} @@ -56,14 +60,14 @@ See [this documentation](README.md) for details on specifying locations and date | `hospital_pks` | facility unique identifiers | `list` of identifiers | | `collection_weeks` | dates | `list` of dates or date ranges | -NOTE: The companion -[`covid_hosp_facility_lookup` endpoint](covid_hosp_facility_lookup.md) can be -used to lookup facility identifiers in a variety of ways. -NOTE: A collection week spans Friday -- Thursday, and weeks are identified by -the date corresponding to the Friday at the start of the week. Therefore, the -`collection_weeks` parameter is formatted as a `YYYYMMDD` date (or list of -dates) rather than an "epiweek" as in other endpoints. +{: .note} +> **NOTEs:** +> - [`covid_hosp_facility_lookup` endpoint](covid_hosp_facility_lookup.md) can > be used to lookup facility identifiers in a variety of ways. +> - A collection week spans Friday -- Thursday, and weeks are identified by +> the date corresponding to the Friday at the start of the week. Therefore, the +> `collection_weeks` parameter is formatted as a `YYYYMMDD` date (or list of +> dates) rather than an "epiweek" as in other endpoints. ### Optional diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md index 657414859..c77b27192 100644 --- a/docs/api/covid_hosp_facility_lookup.md +++ b/docs/api/covid_hosp_facility_lookup.md @@ -8,10 +8,17 @@ nav_order: 2 # COVID-19 Hospitalization: Facility Lookup {: .no_toc} -* **Source name:** `covid_hosp_facility_lookup` -* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) -* **Total facilities:** 4922 -* **License:** [Public Domain US Government](https://www.usa.gov/government-works) + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `covid_hosp_facility_lookup` | +| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) | +| **Geographic Coverage** | Healthcare facility ([state](geographic_codes.html#us-states-and-territories), ccn city, zip, fips) | +| **Update Frequency** | Inactive - No longer updated | +| **License** | [Public Domain US Government](https://www.usa.gov/government-works) | + + ## Overview {: .no_toc} @@ -42,6 +49,8 @@ See [this documentation](README.md) for details on specifying locations and date ## Parameters +### Required + | Parameter | Description | Type | |-------------|-----------------------------------|--------| | `state` | two-letter state abbreviation (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | string | @@ -50,9 +59,10 @@ See [this documentation](README.md) for details on specifying locations and date | `zip` | 5-digit ZIP code | string | | `fips_code` | 5-digit FIPS county code | string | -NOTE: Exactly one of the above parameters must be present in requests. -Combinations of parameters (e.g. specifying both `city` and `state`) are not -supported. +{: .note} +> **NOTE:** Exactly one of the above parameters must be present in requests. +> Combinations of parameters (e.g. specifying both `city` and `state`) are not +> supported. ## Response diff --git a/docs/api/delphi.md b/docs/api/delphi.md index e41346f37..0a4d59448 100644 --- a/docs/api/delphi.md +++ b/docs/api/delphi.md @@ -8,10 +8,17 @@ nav_order: 2 # Delphi Forecasts {: .no_toc} -* **Source name:** `delphi` -* **Earliest issue available:** 2010w01 -* **Time type available:** epiweek -* **License:** [CC BY](https://creativecommons.org/licenses/by/4.0/) + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `delphi` | +| **Data Source** | [Delphi](https://delphi.cmu.edu/) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Systems available** | `af`, `eb`, `ec`, `sp`, `st` | +| **Update Frequency** | Inactive - No longer updated | +| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | + + ## Overview {: .no_toc} @@ -41,7 +48,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | |-----------|-------------|--------------------------------------| -| `system` | system | system name from (...) | +| `system` | system | system name (`af`, `eb`, `ec`, `sp`, `st`) | | `epiweek` | epiweek | epiweek when forecast was made | ## Response @@ -53,18 +60,22 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `epidata[].system` | system | string | | `epidata[].epiweek` | epiweek | integer | | `epidata[].forecast` | forecast structure | object | -| `epidata[].forecast.season` | year (yyyy) | integer | -| `epidata[].forecast.ili_bins` | | integer | +| `epidata[].forecast._version` | forecast version | integer | +| `epidata[].forecast.baselines` | baseline values for each region | object | +| `epidata[].forecast.baselines.` | baseline value for \ | float | | `epidata[].forecast.data` | forecast data for each region | object | | `epidata[].forecast.data.` | forecast data for \ | object | | `epidata[].forecast.data..` | distribution for \ (`peak`, `peakweek`, `onset`, `x1`, `x2`, `x3`, `x4`) | object | -| ... | ... | ... | -| `epidata[].forecast.name` | name = "delphi-epicast" | string | -| `epidata[].forecast.year_weeks` | number of weeks in year | integer | -| `epidata[].forecast.ili_bin_size` | float | -| `epidata[].forecast.season_weeks` | number of weeks in season | integer | -| `epidata[].forecast._version` | forecast version | integer | +| `epidata[].forecast.data...dist` | probability distribution | array of float | +| `epidata[].forecast.data...point` | point estimate | float | +| `epidata[].forecast.data...none` | probability of "none" (if applicable) | float | | `epidata[].forecast.epiweek` | forecast epiweek | integer | +| `epidata[].forecast.ili_bin_size` | size of ILI bins | float | +| `epidata[].forecast.ili_bins` | number of ILI bins | integer | +| `epidata[].forecast.name` | system name | string | +| `epidata[].forecast.season` | season year (yyyy) | integer | +| `epidata[].forecast.season_weeks` | number of weeks in season | integer | +| `epidata[].forecast.year_weeks` | number of weeks in year | integer | | `message` | `success` or error message | string | # Example URLs diff --git a/docs/api/dengue_digital_surveillance.md b/docs/api/dengue_digital_surveillance.md index cd0458f99..0a2770bcc 100644 --- a/docs/api/dengue_digital_surveillance.md +++ b/docs/api/dengue_digital_surveillance.md @@ -9,11 +9,16 @@ permalink: api/dengue_sensors.html # Dengue Digital Surveillance Sensors {: .no_toc} -* **Source name:** `dengue_sensors` -* **Earliest issue available:** 2003w01 - -* **Time type available:** epiweek -* **License:** [CC BY](https://creativecommons.org/licenses/by/4.0/) + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `dengue_sensors` | +| **Data Source** | Various digital data streams | +| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2003w01 | +| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | ## Overview @@ -46,9 +51,9 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | --- | --- | --- | | `auth` | password | string | | `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of location labels | +| `name` | name | `list` of names (`ght`) | +| `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) | - ## Response diff --git a/docs/api/dengue_nowcast.md b/docs/api/dengue_nowcast.md index f7c0cc53a..6b4cdf19b 100644 --- a/docs/api/dengue_nowcast.md +++ b/docs/api/dengue_nowcast.md @@ -8,11 +8,16 @@ nav_order: 2 # Delphi's Dengue Nowcast {: .no_toc} -* **Source name:** `dengue_nowcast` -* **Earliest issue available:** 2014w01 - -* **Time type available:** epiweek -* **License:** Open access + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `dengue_nowcast` | +| **Data Source** | [Delphi](https://delphi.cmu.edu/) | +| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2014w09 | +| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/ | ## Overview @@ -44,7 +49,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `locations` | locations | `list` of location labels | +| `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) | ## Response diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index 155652900..efef9bf4d 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -8,6 +8,18 @@ permalink: api/sensors.html # Digital Surveillance Sensors + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `sensors` | +| **Data Source** | Various digital data streams | +| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | + + + This is the documentation of the API for accessing the Digital Surveillance Sensors (`sensors`) endpoint of the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -18,12 +30,12 @@ General topics not specific to any particular endpoint are discussed in the {: .note} > **Note:** this repository was built to support modelling and forecasting efforts -surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic, -syndromic surveillance data, like ILI data (influenza-like illness) through -FluView, will likely prove very useful. However, **we urge caution to users -examining the digital surveillance sensors**, like ILI Nearby, Google Flu -Trends, etc., during the COVID-19 pandemic, because these were designed to track -ILI as driven by seasonal influenza, and were NOT designed to track ILI during +> surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic, +> syndromic surveillance data, like ILI data (influenza-like illness) through +> FluView, will likely prove very useful. However, **we urge caution to users +> examining the digital surveillance sensors**, like ILI Nearby, Google Flu +> Trends, etc., during the COVID-19 pandemic, because these were designed to track +> ILI as driven by seasonal influenza, and were NOT designed to track ILI during the COVID-19 pandemic. @@ -56,8 +68,6 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ## Response - - | Field | Description | Type | |----------------------|-----------------------------------------------------------------|------------------| | `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index 498e514fc..e128ec6cf 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -8,11 +8,16 @@ nav_order: 2 # ECDC ILI {: .no_toc} -* **Source name:** `ecdc_ili` -* **Earliest issue available:** 2003w40 -* **Regions available:** European countries (see [Geographic Codes](geographic_codes.html#european-countries)) -* **Time type available:** epiweek -* **License:** Open access + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `ecdc_ili` | +| **Data Source** | [European Centre for Disease Prevention and Control (ECDC)](https://www.ecdc.europa.eu/en/home) | +| **Geographic Coverage** | European countries (see [Geographic Codes](geographic_codes.html#european-countries)) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Weekly | +| **Earliest Date** | 2018w40 | +| **License** | Open Access | ## Overview @@ -43,10 +48,6 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required -## Parameters - -### Required - | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | @@ -59,9 +60,10 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `issues` | issues | `list` of epiweeks | | `lag` | # weeks between each epiweek and its issue | integer | -Notes: -- If both `issues` and `lag` are specified, only `issues` is used. -If neither is specified, the current issues are used. +{: .note} +> **Notes:** +> - If both `issues` and `lag` are specified, only `issues` is used. +> - If neither is specified, the current issues are used. ## Response diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index 265f98d13..ecb1914a4 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -8,12 +8,17 @@ nav_order: 2 # FluSurv {: .no_toc} -* **Source name:** `flusurv` -* **Earliest issue available:** 2009w40 -* **Data source:** [Laboratory-Confirmed Influenza Hospitalizations](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html) -* **Location available:** See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list -* **Time type available:** epiweek - + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `flusurv` | +| **Data Source** | [Laboratory-Confirmed Influenza Hospitalizations](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html) | +| **Geographic Coverage** | See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Weekly | +| **Earliest Date** | 2003w40 | + + @@ -62,9 +67,10 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `issues` | issues | `list` of epiweeks | | `lag` | # weeks between each epiweek and its issue | integer | -Notes: -- If both `issues` and `lag` are specified, only `issues` is used. -If neither is specified, the current issues are used. +{: .note} +> **Notes:** +> - If both `issues` and `lag` are specified, only `issues` is used. +> - If neither is specified, the current issues are used. ## Response @@ -108,12 +114,13 @@ If neither is specified, the current issues are used. | `epidata[].season` | indicates the start and end years of the winter flu season in the format YYYY-YY (e.g. 2022-23 indicates the flu season running late 2022 through early 2023) | string | | `message` | `success` or error message | string | -Notes: -* The `flusurv` age groups are, in general, not the same as the ILINet +{: .note} +> **Note:** +> * The `flusurv` age groups are, in general, not the same as the ILINet (`fluview`) age groups. However, the following groups are equivalent: - - flusurv age_0 == fluview age_0 (0-4 years) - - flusurv age_3 == fluview age_4 (50-64 years) - - flusurv age_4 == fluview age_5 (65+ years) +> - flusurv age_0 == fluview age_0 (0-4 years) +> - flusurv age_3 == fluview age_4 (50-64 years) +> - flusurv age_4 == fluview age_5 (65+ years) # Example URLs @@ -145,7 +152,7 @@ Notes: # Code Samples Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). -The following samples show how to import the library and fetch CA FluView Clinical data for epiweeks `201940` and `202001-202010` (11 weeks total). +The following samples show how to import the library and fetch CA FluView Clinical data for epiweeks `201701-201801`. ### R diff --git a/docs/api/fluview.md b/docs/api/fluview.md index c362f6dfd..a3f23fd3b 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -8,13 +8,16 @@ nav_order: 1 # FluView (ILINet) {: .no_toc} -* **Source name:** `fluview` -* **Data source:** [United States Centers for Disease Control and Prevention](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) (CDC) -* **Earliest issue available:** 1997w40 -* **Date of last change:** [Weekly (typically Fridays)] -* **Available for:** nat, hhs1-hhs10, and cen1-cen9 (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) -* **Time type available:** epiweek - * **License:** Open Access / [CDC](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `fluview` | +| **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | +| **Geographic Coverage** | National, states, HHS regions, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Weekly (typically Fridays) | +| **Earliest Date** | 1997w40 | +| **License** | Open Access / [CDC](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | Influenza-like illness (ILI) from U.S. Outpatient Influenza-like Illness Surveillance Network (ILINet). @@ -36,7 +39,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `regions` | regions | `list` of region labels: `nat`, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| `regions` | regions | `list` of region labels: `nat`, states, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ### Optional @@ -46,6 +49,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `lag` | # weeks between each epiweek and its issue | integer | | `auth` | password for private imputed data | string | +{: .note} > **Notes:** > - If both `issues` and `lag` are specified, only `issues` is used. > - If neither is specified, the current issues are used. @@ -74,8 +78,9 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `epidata[].ili` | percent influenza-like illness | float | | `message` | `success` or error message | string | -Notes: -- If authorized via `auth`, private data is not included. +{: .note} +> **Notes:** +> - If authorized via `auth`, private data is not included. # Example URLs diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index b9b52932e..fa1bdda9f 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -8,11 +8,16 @@ nav_order: 1 # FluView Clinical {: .no_toc} -* **Source name:** `fluview_clinical` -* **Earliest issue available:** 2010w40 -* **Available for:** nat, hhs1-hhs10, and cen1-cen9 (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) -* **Time type available:** epiweek -* **License:** Open Access + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `fluview_clinical` | +| **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | +| **Geographic Coverage** | National, HHS regions, states, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Weekly (typically Fridays) | +| **Earliest Date** | 2016w40 | +| **License** | Open Access | ## Overview @@ -32,7 +37,6 @@ General topics not specific to any particular endpoint are discussed in the {:toc} - # The API The base URL is: https://api.delphi.cmu.edu/epidata/fluview_clinical/ @@ -46,7 +50,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `epiweeks` | epiweeks | `list` of epiweeks | -| `regions` | regions | `list` of region labels: `nat`, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| `regions` | regions | `list` of region labels: `nat`, states, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ### Optional @@ -55,9 +59,10 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `issues` | issues | `list` of epiweeks | | `lag` | # weeks between each epiweek and its issue | integer | -Notes: -- If both `issues` and `lag` are specified, only `issues` is used. -If neither is specified, the current issues are used. +{: .note} +> **Notes:** +> - If both `issues` and `lag` are specified, only `issues` is used. +> - If neither is specified, the current issues are used. ## Response @@ -90,17 +95,16 @@ https://api.delphi.cmu.edu/epidata/fluview_clinical/?regions=nat&epiweeks=202001 { "release_date": "2021-10-08", "region": "nat", - "issue": 202014, + "issue": 202139, "epiweek": 202001, - "lag": 13, - "total_specimens": 64980, - "total_a": 5651, - "total_b": 9647, - "percent_positive": 23.5426, - "percent_a": 8.69652, - "percent_b": 14.8461 - }, - ... + "lag": 91, + "total_specimens": 65177, + "total_a": 5645, + "total_b": 9664, + "percent_positive": 23.4883, + "percent_a": 8.66103, + "percent_b": 14.8273 + } ], "message": "success" } diff --git a/docs/api/fluview_meta.md b/docs/api/fluview_meta.md index 0826a98ba..e41b91bec 100644 --- a/docs/api/fluview_meta.md +++ b/docs/api/fluview_meta.md @@ -7,6 +7,14 @@ nav_order: 1 # FluView Metadata + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `fluview_meta` | +| **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | +| **Update Frequency** | Weekly (typically Fridays) | +| **License** | Open Access | + This is the API documentation for accessing the FluView metadata (`fluview_meta`) endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -59,3 +67,28 @@ https://api.delphi.cmu.edu/epidata/fluview_meta/ "message": "success" } ``` + +# Code Samples + +Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). +The following samples show how to import the library and fetch FluView metadata. + +### R + +```R +library(epidatr) +# Fetch data +res <- pub_fluview_meta() +print(res) +``` + +### Python + +```python +# Import +from epidatpy import EpiDataContext +# Fetch data +epidata = EpiDataContext() +res = epidata.pub_fluview_meta() +print(res) +``` diff --git a/docs/api/geographic_codes.md b/docs/api/geographic_codes.md index 4f3cad2a2..9273e18b5 100644 --- a/docs/api/geographic_codes.md +++ b/docs/api/geographic_codes.md @@ -15,11 +15,14 @@ This page documents the valid geographic codes accepted by various API endpoints 1. TOC {:toc} -## PAHO Dengue +## Countries and Territories in the Americas -The [PAHO Dengue](paho_dengue.html) endpoint accepts ISO 3166-1 alpha-2 country codes for countries and territories in the Americas. +Multiple endpoints accept ISO 3166-1 alpha-2 country codes for countries and territories in the Americas. -### Supported Region Codes +{: .note} +> **Note:** While the API accepts codes for all countries listed below, data may not be available for every country or territory. + +### Supported Codes | Code | Name | |---|---| @@ -71,9 +74,15 @@ The [PAHO Dengue](paho_dengue.html) endpoint accepts ISO 3166-1 alpha-2 country | US | United States of America | | UY | Uruguay | | VC | Saint Vincent and the Grenadines | +| VE | Venezuela | | VG | Virgin Islands (UK) | | VI | Virgin Islands (US) | + ## US Regions and States @@ -122,6 +131,8 @@ The US Census Bureau divides the country into 9 divisions. Full list of 51 US states and territories used by multiple endpoints: +#### US States + | Code | Name | |---|---| | AK | Alaska | @@ -176,6 +187,19 @@ Full list of 51 US states and territories used by multiple endpoints: | WV | West Virginia | | WY | Wyoming | +#### US Territories + +| Code | Name | +|---|---| +| PR | Puerto Rico | +| VI | Virgin Islands | +| GU | Guam | +| AS | American Samoa | +| MP | Northern Mariana Islands | +| FM | Federated States of Micronesia | +| MH | Marshall Islands | +| PW | Palau | + ## Selected US cities Selected US cities used by multiple endpoints. diff --git a/docs/api/gft.md b/docs/api/gft.md index 030d074d4..6c5e84c48 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -8,13 +8,16 @@ nav_order: 2 # Google Flu Trends {: .no_toc} -* **Source name:** `gft` -* **Data Source:** [Google Flu Trends Estimates](https://www.google.com/publicdata/explore?ds=z3bsqef7ki44ac_) ([context](https://en.wikipedia.org/wiki/Google_Flu_Trends)) -* **Earliest issue available:** 2003w40 -* **Available for:** US states, census regions, and select cities ([regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt), [states](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt), [cities](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/cities.txt)) -* **Temporal Resolution:** Weekly -* **Spatial Resolution:** National, HHS regions, US states (see [US Regions and States](geographic_codes.html#us-regions-and-states)), and select cities (see [Selected US Cities](geographic_codes.html#selected-us-cities)) -* **License:** Open access + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `gft` | +| **Data Source** | [Google Flu Trends Estimates](https://www.google.com/publicdata/explore?ds=z3bsqef7ki44ac_) ([context](https://en.wikipedia.org/wiki/Google_Flu_Trends)) | +| **Geographic Coverage** | National, HHS regions, US states (see [US Regions and States](geographic_codes.html#us-regions-and-states)), and select cities (see [Selected US Cities](geographic_codes.html#selected-us-cities)) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | +| **Earliest Date** | 2003w40 | +| **License** | Open Access | ## Overview @@ -42,10 +45,6 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a ### Required -## Parameters - -### Required - | Parameter | Description | Type | | --- | --- | --- | | `locations` | Locations to fetch. National, HHS regions, US states (see [US Regions and States](geographic_codes.html#us-regions-and-states)), and select cities (see [Selected US Cities](geographic_codes.html#selected-us-cities)). | `list` of strings | @@ -58,8 +57,8 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | | `epidata` | list of results | array of objects | | `epidata[].location` | location | string | -| `epidata[].epiweek` | epiweek | epiweek | -| `epidata[].num` | number | integer | +| `epidata[].epiweek` | epiweek | integer | +| `epidata[].num` | GFT estimate | integer | | `message` | `success` or error message | string | # Example URLs diff --git a/docs/api/ght.md b/docs/api/ght.md index 0ba634885..558f47aa6 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -8,11 +8,17 @@ nav_order: 2 # Google Health Trends {: .no_toc} -* **Source name:** `ght` -* **Earliest issue available:** 2003w40 -* **Available for:** [US States](geographic_codes.html#us-states-and-territories) and national level (US) -* **Time type available:** epiweek -* **License:** Restricted (requires auth) + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `ght` | +| **Data Source** | Google Health Trends | +| **Geographic Coverage** | [US States](geographic_codes.html#us-states-and-territories) and national level (US) | +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated | + + This is the API documentation for accessing the Google Health Trends (`ght`) endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -50,7 +56,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `auth` | password | string | | `epiweeks` | epiweeks | `list` of epiweeks | | `locations` | locations | `list` of state codes (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) and/or `US` | -| `query` | search query or topic ID (see https://www.freebase.com/) | string | +| `query` | search query or topic ID | string | ## Response diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index 84d539252..904369849 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -13,13 +13,13 @@ permalink: api/nowcast.html | Attribute | Details | | :--- | :--- | | **Source Name** | `nowcast` | -| **Data Source:** | [Delphi's ILI Nearby system](https://delphi.cmu.edu/nowcast/) +| **Data Source** | [Delphi's ILI Nearby system](https://delphi.cmu.edu/nowcast/) | | **Dataset Type** | Predictive (Leading Indicator) | | **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Released Friday; updated Sunday & Monday | | **Earliest Date** | 2010w30 | -| **License** | Open Access | +| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | ## Overview {: .no_toc} diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index 604b53ee9..98866d7a6 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -12,7 +12,7 @@ nav_order: 2 | Attribute | Details | | :--- | :--- | | **Source Name** | `kcdc_ili` | -| **Data Source:** | [Korea Disease Control and Prevention Agency (KCDC) ILI surveillance](https://www.kdca.go.kr/) | +| **Data Source** | [Korea Disease Control and Prevention Agency (KCDC) ILI surveillance](https://www.kdca.go.kr/) | | **Geographic Coverage** | ROK (Republic of Korea) (see [Geographic Codes](geographic_codes.md#republic-of-korea)) | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Inactive - No longer updated | diff --git a/docs/api/norostat.md b/docs/api/norostat.md index 587f42bbb..f14f03f76 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.md @@ -19,7 +19,7 @@ nav_order: 2 | **Update Frequency** | Inactive - Delphi stopped stopped acquiring data from this data source in November 2020. | | **Earliest Date** | 2012w31 | - + ## Overview {: .no_toc} diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index cee15c266..e22648cd6 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -13,12 +13,12 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `paho_dengue` | | **Data Source** | [Pan American Health Organization (PAHO) Dengue surveillance](https://www.paho.org/en/arbo-portal/dengue-data-and-analysis) | -| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#paho-dengue)) | +| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Inactive - No longer updated | - + + ## Overview {: .no_toc} From fd8432942237c990620ad03239e0d8415461df46 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Wed, 26 Nov 2025 14:17:54 -0800 Subject: [PATCH 35/64] docs: remove duplicated paragraph on nidss_dengue --- docs/api/nidss_dengue.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 877c198cb..4dc3ff418 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -163,5 +163,4 @@ print(res['result'], res['message'], len(res['epidata'])) # Source and Licensing -The full text of the NIDSS Dengue license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license). The full text of the NIDSS Dengue license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license). \ No newline at end of file From 161a142f42ecf94e7faf41c6e9b650cfffbda402 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Wed, 26 Nov 2025 16:28:01 -0800 Subject: [PATCH 36/64] docs: improve site style --- docs/_config.yml | 2 + docs/_sass/color_schemes/delphi.scss | 27 ++++ docs/_sass/custom/custom.scss | 229 +++++++++++++++++++++++++++ 3 files changed, 258 insertions(+) create mode 100644 docs/_sass/color_schemes/delphi.scss create mode 100644 docs/_sass/custom/custom.scss diff --git a/docs/_config.yml b/docs/_config.yml index 2d8a45c17..5e03c9aac 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -57,3 +57,5 @@ favicon_ico: "favicon.ico" # - vendor/cache/ # - vendor/gems/ # - vendor/ruby/ + +color_scheme: delphi \ No newline at end of file diff --git a/docs/_sass/color_schemes/delphi.scss b/docs/_sass/color_schemes/delphi.scss new file mode 100644 index 000000000..dc50b168e --- /dev/null +++ b/docs/_sass/color_schemes/delphi.scss @@ -0,0 +1,27 @@ +// Delphi Color Scheme - Delphidocs Style +// Blue headings/title, Red links + +// Core Colors +$cmu-red: #C41230; +$berkley-blue: #002676; // Dark Blue from screenshot +$fg: #172431; // Dark Gray/Black +$bg: #fff; +$border: #e1e4e8; + +// Base Colors +$body-background-color: $bg; +$body-text-color: $fg; +$headings-color: $berkley-blue; // Blue headings +$link-color: $cmu-red; // Red links +$border-color: $border; + +// Sidebar and Navigation +$site-title-color: $berkley-blue; // Blue site title +$nav-list-link-color: $fg; +$nav-list-link-hover-color: $berkley-blue; +$nav-list-link-active-color: $berkley-blue; +$nav-child-link-color: $fg; + +// Code +$code-background-color: #f6f8fa; +$code-text-color: $fg; \ No newline at end of file diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss new file mode 100644 index 000000000..42ac11adf --- /dev/null +++ b/docs/_sass/custom/custom.scss @@ -0,0 +1,229 @@ +@import url('https://fonts.googleapis.com/css2?family=Source+Serif+Pro:wght@400;600;700&family=Source+Sans+Pro:wght@400;600&display=swap'); + +body { + font-family: 'Source Sans Pro', Helvetica, Arial, sans-serif; + color: var(--body-text); +} + +.site-header { + transition: all 0.3s ease; + border-bottom: none !important; + /* Removed hard blue line */ + background-color: var(--body-background) !important; + font-family: 'Source Serif Pro', serif !important; + box-shadow: 0 4px 12px rgba(0, 0, 0, 0.03); + /* Better, softer shadow */ +} + +.site-title { + font-family: 'Source Serif Pro', serif !important; + font-weight: 600; + color: #002676 !important; + white-space: nowrap !important; +} + +.main-content h1 { + border-bottom: none; + line-height: 1.15; + margin: 2.75rem 0 1.05rem; +} + +h1, +h2, +h3, +h4, +h5, +h6, +h7 { + font-family: 'Source Serif Pro', serif !important; + color: #002676 !important; + line-height: 1.15; + margin: 2.75rem 0 1.05rem; +} + +aside { + padding-top: 1.5rem; + border-left: none; + /* Removed blue line on the left */ + + h2 { + margin-top: 1.2rem; + font-size: 1.25rem; + font-family: 'Source Serif Pro', serif; + color: #002676; + } + + .roles { + color: var(--body-text); + opacity: 0.8; + } + + .nav-list-item { + margin-bottom: 0.25rem; + } + + .nav-list-link { + padding: 0.25rem 0.5rem; + border-radius: 4px; + transition: background-color 0.2s, color 0.2s; + + &:hover { + background-color: rgba(0, 38, 118, 0.05); + /* Very subtle blue blend */ + color: #C41230; + text-decoration: none; + } + + &.active { + font-weight: 600; + color: #C41230; + background-color: rgba(196, 18, 48, 0.03); + /* Subtle red blend for active */ + } + } + + .list-unstyled li { + margin-bottom: 0.5rem; + } + + .dev-status .list-unstyled li { + margin-bottom: 0.1rem; + } +} + +@media (max-width: 576px) { + aside { + margin: 0.5rem; + width: calc(100vw - 1rem); + background-color: #f8f9fa; + border-radius: 4px; + box-shadow: 0 4px 12px rgba(0, 0, 0, 0.05); + + h2:first-child { + margin-top: 1rem; + } + } +} + +.row>main { + margin-bottom: 56px; +} + +footer { + border-top: 1px solid rgba(0, 0, 0, 0.05); + /* Subtle blend instead of hard line */ + margin: 0 0 1rem 0; + font-size: 0.8rem; + color: var(--body-text); + padding-top: 1rem; +} + +.site-footer-credits { + display: none !important; +} + +table { + width: 100%; + border-collapse: collapse; + margin-bottom: 1.5rem; + + th, + td { + padding: 0.75rem; + border-bottom: 1px solid rgba(0, 0, 0, 0.1); + /* Softer borders */ + } + + th { + text-align: left; + font-weight: 600; + color: #002676; + border-bottom: 2px solid rgba(0, 38, 118, 0.2); + /* Softer header underline */ + } +} + +code { + background-color: rgba(0, 0, 0, 0.04); + /* Blended background */ + padding: 0.2em 0.4em; + border-radius: 3px; + font-size: 85%; +} + +pre code { + background-color: transparent; + padding: 0; +} + +/* Callouts - softer blend */ +.note, +.warning, +.important, +.tip, +.caution { + padding: 1rem; + margin: 1.5rem 0; + border-left: 4px solid; + border-radius: 4px; + box-shadow: 0 2px 5px rgba(0, 0, 0, 0.02); + /* Subtle lift */ + + >p { + margin: 0; + } + + >p:first-child strong:first-child { + display: block; + margin-bottom: 0.5rem; + font-size: 0.9rem; + text-transform: uppercase; + letter-spacing: 0.05em; + } +} + +.note, +.important { + background-color: rgba(0, 38, 118, 0.03); + /* Blended Blue */ + border-left-color: #002676; + color: #002676; + + >p:first-child strong:first-child { + color: #002676; + } +} + +.warning, +.caution { + background-color: rgba(196, 18, 48, 0.03); + /* Blended Red */ + border-left-color: #C41230; + color: #941120; + + >p:first-child strong:first-child { + color: #C41230; + } +} + +.tip { + background-color: rgba(54, 143, 51, 0.05); + /* Blended Green */ + border-left-color: #368f33; + color: #1b5e20; + + >p:first-child strong:first-child { + color: #2e7d32; + } +} + +.note>blockquote, +.warning>blockquote, +.important>blockquote, +.tip>blockquote, +.caution>blockquote { + border-left: none; + padding-left: 0; + margin-left: 0; + color: inherit; +} \ No newline at end of file From ecd7db33aa33bc3f3b4626b64902ae0e22b7e7be Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Thu, 27 Nov 2025 11:55:34 -0800 Subject: [PATCH 37/64] docs: improve colour style for quotes and add an overview section; quotes endpoints are missing it. --- docs/_sass/color_schemes/delphi.scss | 10 +++++----- docs/_sass/custom/custom.scss | 27 +++++++++++---------------- docs/api/covidcast.md | 11 ++--------- docs/api/flusurv.md | 6 +++--- docs/api/fluview.md | 9 +++++++++ docs/api/fluview_meta.md | 9 +++++++++ 6 files changed, 39 insertions(+), 33 deletions(-) diff --git a/docs/_sass/color_schemes/delphi.scss b/docs/_sass/color_schemes/delphi.scss index dc50b168e..db2b1f832 100644 --- a/docs/_sass/color_schemes/delphi.scss +++ b/docs/_sass/color_schemes/delphi.scss @@ -3,20 +3,20 @@ // Core Colors $cmu-red: #C41230; -$berkley-blue: #002676; // Dark Blue from screenshot -$fg: #172431; // Dark Gray/Black +$berkley-blue: #002676; +$fg: #172431; $bg: #fff; $border: #e1e4e8; // Base Colors $body-background-color: $bg; $body-text-color: $fg; -$headings-color: $berkley-blue; // Blue headings -$link-color: $cmu-red; // Red links +$headings-color: $berkley-blue; +$link-color: $cmu-red; $border-color: $border; // Sidebar and Navigation -$site-title-color: $berkley-blue; // Blue site title +$site-title-color: $berkley-blue; $nav-list-link-color: $fg; $nav-list-link-hover-color: $berkley-blue; $nav-list-link-active-color: $berkley-blue; diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss index 42ac11adf..c03fafc3e 100644 --- a/docs/_sass/custom/custom.scss +++ b/docs/_sass/custom/custom.scss @@ -8,11 +8,9 @@ body { .site-header { transition: all 0.3s ease; border-bottom: none !important; - /* Removed hard blue line */ background-color: var(--body-background) !important; font-family: 'Source Serif Pro', serif !important; box-shadow: 0 4px 12px rgba(0, 0, 0, 0.03); - /* Better, softer shadow */ } .site-title { @@ -44,7 +42,6 @@ h7 { aside { padding-top: 1.5rem; border-left: none; - /* Removed blue line on the left */ h2 { margin-top: 1.2rem; @@ -69,7 +66,6 @@ aside { &:hover { background-color: rgba(0, 38, 118, 0.05); - /* Very subtle blue blend */ color: #C41230; text-decoration: none; } @@ -78,7 +74,6 @@ aside { font-weight: 600; color: #C41230; background-color: rgba(196, 18, 48, 0.03); - /* Subtle red blend for active */ } } @@ -111,7 +106,6 @@ aside { footer { border-top: 1px solid rgba(0, 0, 0, 0.05); - /* Subtle blend instead of hard line */ margin: 0 0 1rem 0; font-size: 0.8rem; color: var(--body-text); @@ -131,7 +125,6 @@ table { td { padding: 0.75rem; border-bottom: 1px solid rgba(0, 0, 0, 0.1); - /* Softer borders */ } th { @@ -139,13 +132,11 @@ table { font-weight: 600; color: #002676; border-bottom: 2px solid rgba(0, 38, 118, 0.2); - /* Softer header underline */ } } code { background-color: rgba(0, 0, 0, 0.04); - /* Blended background */ padding: 0.2em 0.4em; border-radius: 3px; font-size: 85%; @@ -156,7 +147,6 @@ pre code { padding: 0; } -/* Callouts - softer blend */ .note, .warning, .important, @@ -167,7 +157,6 @@ pre code { border-left: 4px solid; border-radius: 4px; box-shadow: 0 2px 5px rgba(0, 0, 0, 0.02); - /* Subtle lift */ >p { margin: 0; @@ -182,10 +171,18 @@ pre code { } } -.note, +.note { + background-color: rgba(0, 123, 192, 0.05); + border-left-color: #007BC0; + color: #007BC0; + + >p:first-child strong:first-child { + color: #007BC0; + } +} + .important { - background-color: rgba(0, 38, 118, 0.03); - /* Blended Blue */ + background-color: rgba(0, 38, 118, 0.05); border-left-color: #002676; color: #002676; @@ -197,7 +194,6 @@ pre code { .warning, .caution { background-color: rgba(196, 18, 48, 0.03); - /* Blended Red */ border-left-color: #C41230; color: #941120; @@ -208,7 +204,6 @@ pre code { .tip { background-color: rgba(54, 143, 51, 0.05); - /* Blended Green */ border-left-color: #368f33; color: #1b5e20; diff --git a/docs/api/covidcast.md b/docs/api/covidcast.md index 6e6d7fbce..d22f63fab 100644 --- a/docs/api/covidcast.md +++ b/docs/api/covidcast.md @@ -18,15 +18,8 @@ selected geographical areas---counties, states, metropolitan statistical areas, and other divisions. -
Get -updates: Delphi operates a mailing -list for users of the COVIDcast API. We will use the list to announce API -changes, corrections to data, and new features; API users may also use the -mailing list to ask general questions about its use. If you use the API, we -strongly encourage you to subscribe. -
+> **Get updates:** Delphi operates a [mailing list](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api) for users of the COVIDcast API. We will use the list to announce API changes, corrections to data, and new features; API users may also use the mailing list to ask general questions about its use. If you use the API, we strongly encourage you to [subscribe](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api). +{: .important } ## Table of contents {: .no_toc .text-delta} diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index ecb1914a4..e7f3d310b 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -1,5 +1,5 @@ --- -title: inactive Flusurv +title: Flusurv parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) nav_order: 2 @@ -15,10 +15,10 @@ nav_order: 2 | **Data Source** | [Laboratory-Confirmed Influenza Hospitalizations](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html) | | **Geographic Coverage** | See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Weekly | | **Earliest Date** | 2003w40 | - + diff --git a/docs/api/fluview.md b/docs/api/fluview.md index a3f23fd3b..94c179cff 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -19,6 +19,9 @@ nav_order: 1 | **Earliest Date** | 1997w40 | | **License** | Open Access / [CDC](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | +## Overview +{: .no_toc} + Influenza-like illness (ILI) from U.S. Outpatient Influenza-like Illness Surveillance Network (ILINet). General topics not specific to any particular endpoint are discussed in the @@ -26,6 +29,12 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + # The API The base URL is: https://api.delphi.cmu.edu/epidata/fluview/ diff --git a/docs/api/fluview_meta.md b/docs/api/fluview_meta.md index e41b91bec..2b423e432 100644 --- a/docs/api/fluview_meta.md +++ b/docs/api/fluview_meta.md @@ -15,6 +15,9 @@ nav_order: 1 | **Update Frequency** | Weekly (typically Fridays) | | **License** | Open Access | +## Overview +{: .no_toc} + This is the API documentation for accessing the FluView metadata (`fluview_meta`) endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -24,6 +27,12 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + ## FluView Metadata Returns information about the [`fluview` endpoint](fluview.md). From 241b8faf6952067356a2d080c49be8a9c9a03cd1 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Thu, 27 Nov 2025 14:42:23 -0800 Subject: [PATCH 38/64] docs: update text regarding legacy clients. --- docs/api/01meta.md | 2 +- docs/api/cdc.md | 2 +- docs/api/covid_hosp.md | 2 +- docs/api/covid_hosp_facility.md | 2 +- docs/api/covid_hosp_facility_lookup.md | 2 +- docs/api/delphi.md | 2 +- docs/api/digital_surveillance_sensors.md | 2 +- docs/api/ecdc_ili.md | 2 +- docs/api/flusurv.md | 2 +- docs/api/fluview.md | 2 +- docs/api/fluview_clinical.md | 2 +- docs/api/gft.md | 2 +- docs/api/ght.md | 2 +- docs/api/ili_nearby_nowcast.md | 2 +- docs/api/kcdc_ili.md | 2 +- docs/api/nidss_dengue.md | 2 +- docs/api/nidss_flu.md | 2 +- docs/api/norostat.md | 2 +- docs/api/norostat_meta.md | 2 +- docs/api/paho_dengue.md | 2 +- docs/api/quidel.md | 2 +- docs/api/twitter.md | 2 +- docs/api/wiki.md | 2 +- 23 files changed, 23 insertions(+), 23 deletions(-) diff --git a/docs/api/01meta.md b/docs/api/01meta.md index 55fe1e484..4e6498eb5 100644 --- a/docs/api/01meta.md +++ b/docs/api/01meta.md @@ -153,7 +153,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/cdc.md b/docs/api/cdc.md index 616c028f0..10f440ce1 100644 --- a/docs/api/cdc.md +++ b/docs/api/cdc.md @@ -149,7 +149,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md index 744e82946..94376629d 100644 --- a/docs/api/covid_hosp.md +++ b/docs/api/covid_hosp.md @@ -254,7 +254,7 @@ print(res) ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/covid_hosp_facility.md b/docs/api/covid_hosp_facility.md index 9f9e39e93..454f715c3 100644 --- a/docs/api/covid_hosp_facility.md +++ b/docs/api/covid_hosp_facility.md @@ -239,7 +239,7 @@ print(res) ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md index c77b27192..a0a4e10f6 100644 --- a/docs/api/covid_hosp_facility_lookup.md +++ b/docs/api/covid_hosp_facility_lookup.md @@ -157,7 +157,7 @@ print(res) ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/delphi.md b/docs/api/delphi.md index 0a4d59448..a45bd7b0c 100644 --- a/docs/api/delphi.md +++ b/docs/api/delphi.md @@ -208,7 +208,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index efef9bf4d..b4c3abb92 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -149,7 +149,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index e128ec6cf..39597719f 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -151,7 +151,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index e7f3d310b..cf6643c3d 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -196,7 +196,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/fluview.md b/docs/api/fluview.md index 94c179cff..7788263a5 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -180,7 +180,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index fa1bdda9f..9b8aa023a 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -156,7 +156,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/gft.md b/docs/api/gft.md index 6c5e84c48..50dc81cfb 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -128,7 +128,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/ght.md b/docs/api/ght.md index 558f47aa6..6f6bad7a1 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -138,7 +138,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index 904369849..3c5476842 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -137,7 +137,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index 98866d7a6..f36bfa562 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -150,7 +150,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 4dc3ff418..e9b8a2262 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -130,7 +130,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index 72ed231bc..61f9410c7 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -150,7 +150,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/norostat.md b/docs/api/norostat.md index f14f03f76..176d6fb2e 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.md @@ -131,7 +131,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/norostat_meta.md b/docs/api/norostat_meta.md index d25681a61..7ff8a54f5 100644 --- a/docs/api/norostat_meta.md +++ b/docs/api/norostat_meta.md @@ -140,7 +140,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index e22648cd6..2b64e19a6 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -146,7 +146,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/quidel.md b/docs/api/quidel.md index 51898687b..2c53774a9 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -132,7 +132,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/twitter.md b/docs/api/twitter.md index f0d2e8b20..2cdd1498d 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -149,7 +149,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) diff --git a/docs/api/wiki.md b/docs/api/wiki.md index 09f5c39ab..891ad3c9d 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -173,7 +173,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using our modern client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). #### R (Legacy) From c6370ae76728ec9ffb56703828cbfa22a44c51e2 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Thu, 27 Nov 2025 14:56:45 -0800 Subject: [PATCH 39/64] docs: mark Flusurv as active and Google Symptoms and Change Healthcare as inactive. Also, removed an outdated message indicating a previous period offline. --- docs/api/covidcast-signals/chng.md | 6 ++---- docs/api/covidcast-signals/google-symptoms.md | 4 ++-- docs/api/flusurv.md | 2 +- 3 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/api/covidcast-signals/chng.md b/docs/api/covidcast-signals/chng.md index 2b36a1381..51e435ec2 100644 --- a/docs/api/covidcast-signals/chng.md +++ b/docs/api/covidcast-signals/chng.md @@ -1,8 +1,8 @@ --- -title: Change Healthcare +title: inactive Change Healthcare parent: Data Sources and Signals grand_parent: Main Endpoint (COVIDcast) -nav_order: 1 +nav_order: 2 --- # Change Healthcare @@ -17,8 +17,6 @@ nav_order: 1 ## Overview {: .no_toc} -**Notice: This data source was inactive between 2021-10-04 and 2021-12-02 to allow us resolve some problems with the data pipeline. We have resumed daily updates and are working on a data patch to fill the gap. [Additional details on this inactive period are available below](#pipeline-pause).** - This data source is based on Change Healthcare claims data that has been de-identified in accordance with HIPAA privacy regulations. Change Healthcare is a healthcare technology company that aggregates data from many healthcare providers. diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index a78c042ca..c37d84c6c 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -1,8 +1,8 @@ --- -title: Google Symptom Search Trends +title: inactive Google Symptom Search Trends parent: Data Sources and Signals grand_parent: Main Endpoint (COVIDcast) -nav_order: 1 +nav_order: 2 --- # Google Symptoms diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index cf6643c3d..f505c121a 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -2,7 +2,7 @@ title: Flusurv parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 +nav_order: 1 --- # FluSurv From 32497c5cff4574e9e8dcca3bf7f4e07fc5ca5f00 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Fri, 28 Nov 2025 00:35:54 -0800 Subject: [PATCH 40/64] docs: enable URLs to display as clickable links. --- docs/api/01meta.md | 4 ++-- docs/api/README.md | 8 ++++---- docs/api/cdc.md | 4 ++-- docs/api/covid_hosp.md | 4 ++-- docs/api/covid_hosp_facility.md | 4 ++-- docs/api/covid_hosp_facility_lookup.md | 4 ++-- docs/api/covidcast-signals/nchs-mortality.md | 2 +- docs/api/covidcast_api_queries.md | 8 ++++---- docs/api/covidcast_meta.md | 4 ++-- docs/api/delphi.md | 4 ++-- docs/api/dengue_digital_surveillance.md | 4 ++-- docs/api/dengue_nowcast.md | 4 ++-- docs/api/digital_surveillance_sensors.md | 4 ++-- docs/api/ecdc_ili.md | 4 ++-- docs/api/fluview.md | 8 ++++---- docs/api/fluview_clinical.md | 4 ++-- docs/api/fluview_meta.md | 4 ++-- docs/api/gft.md | 4 ++-- docs/api/ght.md | 6 +++--- docs/api/ili_nearby_nowcast.md | 4 ++-- docs/api/kcdc_ili.md | 4 ++-- docs/api/nidss_dengue.md | 4 ++-- docs/api/nidss_flu.md | 4 ++-- docs/api/norostat.md | 4 ++-- docs/api/norostat_meta.md | 4 ++-- docs/api/paho_dengue.md | 4 ++-- docs/api/quidel.md | 4 ++-- docs/api/twitter.md | 4 ++-- docs/api/wiki.md | 6 +++--- 29 files changed, 65 insertions(+), 65 deletions(-) diff --git a/docs/api/01meta.md b/docs/api/01meta.md index 4e6498eb5..7ecd67387 100644 --- a/docs/api/01meta.md +++ b/docs/api/01meta.md @@ -22,7 +22,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/meta/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -41,7 +41,7 @@ None. # Example URLs -https://api.delphi.cmu.edu/epidata/meta/ + ```json { diff --git a/docs/api/README.md b/docs/api/README.md index 9c4977a62..b12cabc24 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -40,7 +40,7 @@ like to cite it, we would gratefully recommend the following copy: > Roni Rosenfeld > (2015). > _Delphi Epidata API_. -> https://github.com/cmu-delphi/delphi-epidata +> ## Data Licensing @@ -71,7 +71,7 @@ Please note that our `endpoint` parameters were previously referenced as `source # The API -The base URL is: https://api.delphi.cmu.edu/epidata/ +The base URL is: ## Specifying Epiweeks, Dates, and Lists @@ -153,7 +153,7 @@ The parameters available for each source are documented in each linked source-sp # Example URLs ### FluView on 2015w01 (national) -https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501 + ```json { @@ -183,7 +183,7 @@ https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501 ``` ### Wikipedia Access article "influenza" on 2020w01 -https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&epiweeks=202001 + ```json { diff --git a/docs/api/cdc.md b/docs/api/cdc.md index 10f440ce1..824c6a1ef 100644 --- a/docs/api/cdc.md +++ b/docs/api/cdc.md @@ -40,7 +40,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/cdc/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -77,7 +77,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### CDC Page Hits on 2015w01 (national) -https://api.delphi.cmu.edu/epidata/cdc/?auth=...&locations=nat&epiweeks=201501 + ```json { diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md index 94376629d..fa625a997 100644 --- a/docs/api/covid_hosp.md +++ b/docs/api/covid_hosp.md @@ -53,7 +53,7 @@ General topics not specific to any particular data source are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/ +The base URL is: See [this documentation](README.md) for details on specifying locations and dates. @@ -89,7 +89,7 @@ If `issues` is not specified, then the most recent issue is used by default. # Example URLs ### MA on 2020-05-10 (per most recent issue) -https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=20200510 + ```json { diff --git a/docs/api/covid_hosp_facility.md b/docs/api/covid_hosp_facility.md index 454f715c3..85a7efff0 100644 --- a/docs/api/covid_hosp_facility.md +++ b/docs/api/covid_hosp_facility.md @@ -47,7 +47,7 @@ General topics not specific to any particular data source are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/covid_hosp_facility/ +The base URL is: See [this documentation](README.md) for details on specifying locations and dates. @@ -97,7 +97,7 @@ has been renamed here for clarity. # Example URLs ### Moses Taylor Hospital (Scranton, PA) on the first collection week of December 2020 (per most recent issue) -https://api.delphi.cmu.edu/epidata/covid_hosp_facility/?hospital_pks=390119&collection_weeks=20201201-20201207 + ```json { diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md index a0a4e10f6..cb20a52f8 100644 --- a/docs/api/covid_hosp_facility_lookup.md +++ b/docs/api/covid_hosp_facility_lookup.md @@ -43,7 +43,7 @@ General topics not specific to any particular data source are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/covid_hosp_facility_lookup/ +The base URL is: See [this documentation](README.md) for details on specifying locations and dates. @@ -88,7 +88,7 @@ Use the `hospital_pk` value when querying # Example URLs ### Lookup facilities in the city of Southlake (TX) -https://api.delphi.cmu.edu/epidata/covid_hosp_facility_lookup/?city=southlake + ```json { diff --git a/docs/api/covidcast-signals/nchs-mortality.md b/docs/api/covidcast-signals/nchs-mortality.md index f7d9eae15..7f7c4cdd9 100644 --- a/docs/api/covidcast-signals/nchs-mortality.md +++ b/docs/api/covidcast-signals/nchs-mortality.md @@ -69,7 +69,7 @@ We report the NCHS Mortality data in a weekly format (`time_type=week` & `time_value={YYYYWW}`, where `YYYYWW` refers to an epiweek). The CDC defines the [epiweek](https://web.archive.org/web/20210623224758/https://wwwn.cdc.gov/nndss/document/MMWR_Week_overview.pdf) as seven days, from Sunday to Saturday. We check the week-ending dates provided in -the NCHS morality data and use Python package +the NCHS mortality data and use Python package [epiweeks](https://pypi.org/project/epiweeks/) to convert them into epiweek format. diff --git a/docs/api/covidcast_api_queries.md b/docs/api/covidcast_api_queries.md index 6954f210d..c13109d15 100644 --- a/docs/api/covidcast_api_queries.md +++ b/docs/api/covidcast_api_queries.md @@ -6,7 +6,7 @@ nav_order: 4 # Constructing API Queries The COVIDcast API is based on HTTP GET queries and returns data in JSON form. -The base URL is `https://api.delphi.cmu.edu/epidata/covidcast/`. +The base URL is . See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -131,11 +131,11 @@ The `fields` parameter can be used to limit which fields are included in each re ## Facebook Survey CLI on 2020-04-06 to 2010-04-10 (county 06001) -https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406-20200410&geo_value=06001 + or -https://api.delphi.cmu.edu/epidata/covidcast/?signal=fb-survey:smoothed_cli&time=day:20200406-20200410&geo=county:06001 + Both of these URLs are equivalent and can be used to get the following result: @@ -159,7 +159,7 @@ Both of these URLs are equivalent and can be used to get the following result: ## Facebook Survey CLI on 2020-04-06 (all counties) -https://api.delphi.cmu.edu/epidata/covidcast/?data_source=fb-survey&signal=smoothed_cli&time_type=day&geo_type=county&time_values=20200406&geo_value=* + ```json { diff --git a/docs/api/covidcast_meta.md b/docs/api/covidcast_meta.md index d6bd4ec13..be77d73e1 100644 --- a/docs/api/covidcast_meta.md +++ b/docs/api/covidcast_meta.md @@ -14,7 +14,7 @@ geographic levels at which they are reported. ## The API -The base URL is: https://api.delphi.cmu.edu/epidata/covidcast_meta/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -47,7 +47,7 @@ None required. ## Example URLs -https://api.delphi.cmu.edu/epidata/covidcast_meta/ + ```json { diff --git a/docs/api/delphi.md b/docs/api/delphi.md index a45bd7b0c..81b422a97 100644 --- a/docs/api/delphi.md +++ b/docs/api/delphi.md @@ -38,7 +38,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/delphi/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -81,7 +81,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### Delphi on 2015w01 (EC) -https://api.delphi.cmu.edu/epidata/delphi/?system=ec&epiweek=201501 + ```json { diff --git a/docs/api/dengue_digital_surveillance.md b/docs/api/dengue_digital_surveillance.md index 0a2770bcc..5a6d05381 100644 --- a/docs/api/dengue_digital_surveillance.md +++ b/docs/api/dengue_digital_surveillance.md @@ -39,7 +39,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/dengue_sensors/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -70,7 +70,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### Dengue Sensors on 2015w01 (Puerto Rico) -https://api.delphi.cmu.edu/epidata/dengue_sensors/?auth=...&locations=pr&epiweeks=201501&names=ght + ```json { diff --git a/docs/api/dengue_nowcast.md b/docs/api/dengue_nowcast.md index 6b4cdf19b..0f5542496 100644 --- a/docs/api/dengue_nowcast.md +++ b/docs/api/dengue_nowcast.md @@ -38,7 +38,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/dengue_nowcast/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -66,7 +66,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### Dengue Nowcast on 2015w01 (Puerto Rico) -https://api.delphi.cmu.edu/epidata/dengue_nowcast/?locations=pr&epiweeks=201401-202301 + ```json { diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index b4c3abb92..c48061184 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -41,7 +41,7 @@ the COVID-19 pandemic. # The API -The base URL is: https://api.delphi.cmu.edu/epidata/sensors/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -81,7 +81,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### Delphi's Digital Surveillance SAR3 Sensor on 2020w01 (national) -https://api.delphi.cmu.edu/epidata/sensors/?auth=...&names=sar3&locations=nat&epiweeks=202001 + ```json { diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index 39597719f..b060babb5 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -40,7 +40,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/ecdc_ili/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -83,7 +83,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### ECDC ILI in Austria on 2020w01 -https://api.delphi.cmu.edu/epidata/ecdc_ili/?regions=austria&epiweeks=202001 + ```json { diff --git a/docs/api/fluview.md b/docs/api/fluview.md index 7788263a5..4ebfbe659 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -37,7 +37,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/fluview/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -94,7 +94,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### FluView on 2015w01 (national) -https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501 + ```json { @@ -125,11 +125,11 @@ https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201501 ### FluView in HHS Regions 4 and 6 for the 2014/2015 flu season -https://api.delphi.cmu.edu/epidata/fluview/?regions=hhs4,hhs6&epiweeks=201440-201520 + ### Updates to FluView on 2014w53, reported from 2015w01 through 2015w10 (national) -https://api.delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201453&issues=201501-201510 + # Code Samples diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index 9b8aa023a..cccd68bad 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -39,7 +39,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/fluview_clinical/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -86,7 +86,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### FluView Clinical on 2020w01 (national) -https://api.delphi.cmu.edu/epidata/fluview_clinical/?regions=nat&epiweeks=202001 + ```json { diff --git a/docs/api/fluview_meta.md b/docs/api/fluview_meta.md index 2b423e432..86f39294a 100644 --- a/docs/api/fluview_meta.md +++ b/docs/api/fluview_meta.md @@ -39,7 +39,7 @@ Returns information about the [`fluview` endpoint](fluview.md). # The API -The base URL is: https://api.delphi.cmu.edu/epidata/fluview_meta/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -61,7 +61,7 @@ There are no parameters for this endpoint. # Example URLs ### FluView Metadata -https://api.delphi.cmu.edu/epidata/fluview_meta/ + ```json { diff --git a/docs/api/gft.md b/docs/api/gft.md index 50dc81cfb..232d5c732 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -37,7 +37,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/gft/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -64,7 +64,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### Google Flu Trends on 2015w01 (national) -https://api.delphi.cmu.edu/epidata/gft/?locations=nat&epiweeks=201501 + ```json { diff --git a/docs/api/ght.md b/docs/api/ght.md index 6f6bad7a1..f6556a2c1 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -43,7 +43,7 @@ This data may be useful for real-time monitoring of diseases, as in: # The API -The base URL is: https://api.delphi.cmu.edu/epidata/ght/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -56,7 +56,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | `auth` | password | string | | `epiweeks` | epiweeks | `list` of epiweeks | | `locations` | locations | `list` of state codes (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) and/or `US` | -| `query` | search query or topic ID | string | +| `query` | search query or topic ID | string | ## Response @@ -73,7 +73,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### Google Health Trends for "how to get over the flu" on 2015w01 (US) -https://api.delphi.cmu.edu/epidata/ght/?auth=...&locations=US&epiweeks=201501&query=how%20to%20get%20over%20the%20flu + ```json { diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index 3c5476842..05ebac0ed 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -44,7 +44,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/nowcast/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -72,7 +72,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### ILI Nearby on 2020w01 (national) -https://api.delphi.cmu.edu/epidata/nowcast/?locations=nat&epiweeks=202001 + ```json { diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index f36bfa562..7a26423bd 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -41,7 +41,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/kcdc_ili/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -84,7 +84,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### KCDC ILI in ROK on 2020w01 -https://api.delphi.cmu.edu/epidata/kcdc_ili/?regions=ROK&epiweeks=202001 + ```json { diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index e9b8a2262..6cfd0ee6c 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -39,7 +39,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/nidss_dengue/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -66,7 +66,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### NIDSS Dengue on 2015w01 (nationwide) -https://api.delphi.cmu.edu/epidata/nidss_dengue/?locations=nationwide&epiweeks=201501 + ```json { diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index 61f9410c7..bd6132096 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -40,7 +40,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/nidss_flu/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -82,7 +82,7 @@ If neither is specified, the current issues are used. # Example URLs ### NIDSS Flu on 2015w01 (nationwide) -https://api.delphi.cmu.edu/epidata/nidss_flu/?regions=nationwide&epiweeks=201501 + ```json { diff --git a/docs/api/norostat.md b/docs/api/norostat.md index 176d6fb2e..38395f8ad 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.md @@ -40,7 +40,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/norostat/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -68,7 +68,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### NoroSTAT on 2015w01 -https://api.delphi.cmu.edu/epidata/norostat/?auth=...&location=Minnesota%2C%20Ohio%2C%20Oregon%2C%20Tennessee%2C%20and%20Wisconsin&epiweeks=201233 + ```json { diff --git a/docs/api/norostat_meta.md b/docs/api/norostat_meta.md index 7ff8a54f5..c18b77621 100644 --- a/docs/api/norostat_meta.md +++ b/docs/api/norostat_meta.md @@ -34,7 +34,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/meta_norostat/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -61,7 +61,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### NoroSTAT Metadata -https://api.delphi.cmu.edu/epidata/meta_norostat/?auth=... + ```json { diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index 2b64e19a6..16173bb8f 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -40,7 +40,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/paho_dengue/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -75,7 +75,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### PAHO Dengue on 2015w01 (Canada) -https://api.delphi.cmu.edu/epidata/paho_dengue/?regions=ca&epiweeks=201501 + ```json { diff --git a/docs/api/quidel.md b/docs/api/quidel.md index 2c53774a9..0112134ec 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -35,7 +35,7 @@ General topics not specific to any particular endpoint are discussed in the [API ## The API -The base URL is: https://api.delphi.cmu.edu/epidata/quidel/ +The base URL is: See this [documentation](https://cmu-delphi.github.io/delphi-epidata/api/README.html) for details on specifying epiweeks, dates, and lists. @@ -63,7 +63,7 @@ See this [documentation](https://cmu-delphi.github.io/delphi-epidata/api/README. # Example URLs ### Quidel on 2015w35-2020w01 (HHS Region 1) -https://api.delphi.cmu.edu/epidata/quidel/?auth=...&locations=hhs1&epiweeks=201535-202001 + ```json { diff --git a/docs/api/twitter.md b/docs/api/twitter.md index 2cdd1498d..6614c435d 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -41,7 +41,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/twitter/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -76,7 +76,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### Twitter on 2015w01 (national) -https://api.delphi.cmu.edu/epidata/twitter/?auth=...&locations=nat&epiweeks=201501 + ```json { diff --git a/docs/api/wiki.md b/docs/api/wiki.md index 891ad3c9d..beb38d45f 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -40,7 +40,7 @@ General topics not specific to any particular endpoint are discussed in the # The API -The base URL is: https://api.delphi.cmu.edu/epidata/wiki/ +The base URL is: See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. @@ -86,7 +86,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a # Example URLs ### Wikipedia Access article "influenza" on 2020w01 -https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&epiweeks=202001 + ```json { @@ -106,7 +106,7 @@ https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&epiweeks ``` ### Wikipedia Access article "influenza" on date 2020-01-01 -https://api.delphi.cmu.edu/epidata/wiki/?language=en&articles=influenza&dates=20200101 + ```json { From d0f9cdfb53835e1700994a3462affc34a82e24e1 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Sun, 30 Nov 2025 19:01:53 -0800 Subject: [PATCH 41/64] docs: add JS tab functionality and SCSS styling for tabs. --- docs/_includes/head_custom.html | 1 + docs/_sass/custom/custom.scss | 3 ++ docs/_sass/custom/tabs.scss | 64 +++++++++++++++++++++++++++++++++ docs/assets/js/tabs.js | 25 +++++++++++++ 4 files changed, 93 insertions(+) create mode 100644 docs/_sass/custom/tabs.scss create mode 100644 docs/assets/js/tabs.js diff --git a/docs/_includes/head_custom.html b/docs/_includes/head_custom.html index da8916bf0..d114d9d62 100644 --- a/docs/_includes/head_custom.html +++ b/docs/_includes/head_custom.html @@ -2,3 +2,4 @@ + diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss index c03fafc3e..1b65f7a0f 100644 --- a/docs/_sass/custom/custom.scss +++ b/docs/_sass/custom/custom.scss @@ -1,5 +1,8 @@ @import url('https://fonts.googleapis.com/css2?family=Source+Serif+Pro:wght@400;600;700&family=Source+Sans+Pro:wght@400;600&display=swap'); +// Import Custom Tabs Styles +@import "custom/tabs"; + body { font-family: 'Source Sans Pro', Helvetica, Arial, sans-serif; color: var(--body-text); diff --git a/docs/_sass/custom/tabs.scss b/docs/_sass/custom/tabs.scss new file mode 100644 index 000000000..d416a51f7 --- /dev/null +++ b/docs/_sass/custom/tabs.scss @@ -0,0 +1,64 @@ +// Code Tabs Styling +.code-tabs { + margin-bottom: 1.5rem; + border: 1px solid var(--border-color); + border-radius: 4px; + overflow: hidden; + + .tab-header { + display: flex; + background-color: #f6f8fa; + border-bottom: 1px solid var(--border-color); + + button { + background: none; + border: none; + padding: 0.75rem 1.5rem; + cursor: pointer; + font-family: 'Source Sans Pro', sans-serif; + font-size: 0.9rem; + color: var(--body-text); + border-right: 1px solid transparent; + border-bottom: 2px solid transparent; + transition: all 0.2s ease; + + &:hover { + color: #007BC0; + background-color: rgba(0, 123, 192, 0.05); + } + + &.active { + color: #002676; + font-weight: 600; + background-color: #fff; + border-bottom: 2px solid #002676; + border-right: 1px solid var(--border-color); + margin-bottom: -1px; + } + + &:focus { + outline: none; + } + } + } + + .tab-content { + display: none; + padding: 1rem; + background-color: #fff; + + &.active { + display: block; + } + + div[class*="language-"] { + margin: 0; + border-radius: 0; + } + + pre { + margin: 0; + border: none; + } + } +} \ No newline at end of file diff --git a/docs/assets/js/tabs.js b/docs/assets/js/tabs.js new file mode 100644 index 000000000..bdf0ace56 --- /dev/null +++ b/docs/assets/js/tabs.js @@ -0,0 +1,25 @@ +// Simple Tab Switching Logic +document.addEventListener('DOMContentLoaded', function () { + const tabContainers = document.querySelectorAll('.code-tabs'); + + tabContainers.forEach(container => { + const headers = container.querySelector('.tab-header'); + const buttons = headers.querySelectorAll('button'); + const contents = container.querySelectorAll('.tab-content'); + + buttons.forEach(button => { + button.addEventListener('click', () => { + buttons.forEach(btn => btn.classList.remove('active')); + contents.forEach(content => content.classList.remove('active')); + + button.classList.add('active'); + + const tabId = button.getAttribute('data-tab'); + const content = container.querySelector(`.tab-content[data-tab="${tabId}"]`); + if (content) { + content.classList.add('active'); + } + }); + }); + }); +}); From 8e3a3ff534ff7001ccf9ba580fadd26c8f31fbbf Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Sun, 30 Nov 2025 19:42:02 -0800 Subject: [PATCH 42/64] docs: Added tab functionality to code samples. --- docs/api/01meta.md | 87 +++++++++------ docs/api/README.md | 2 +- docs/api/cdc.md | 87 +++++++++------ docs/api/client_libraries.md | 101 +++++++++++++----- docs/api/covid_hosp.md | 62 +++++++---- docs/api/covid_hosp_facility.md | 62 +++++++---- docs/api/covid_hosp_facility_lookup.md | 62 +++++++---- .../covid-trends-and-impact-survey.md | 11 +- docs/api/covidcast.md | 27 +++-- docs/api/covidcast_meta.md | 40 ++++--- docs/api/delphi.md | 87 +++++++++------ docs/api/dengue_digital_surveillance.md | 86 +++++++++------ docs/api/dengue_nowcast.md | 89 +++++++++------ docs/api/digital_surveillance_sensors.md | 92 ++++++++++------ docs/api/ecdc_ili.md | 87 +++++++++------ docs/api/flusurv.md | 81 ++++++++++---- docs/api/fluview.md | 83 +++++++++----- docs/api/fluview_clinical.md | 87 +++++++++------ docs/api/fluview_meta.md | 28 +++-- docs/api/gft.md | 87 +++++++++------ docs/api/ght.md | 89 +++++++++------ docs/api/ili_nearby_nowcast.md | 88 +++++++++------ docs/api/kcdc_ili.md | 87 +++++++++------ docs/api/nidss_dengue.md | 89 +++++++++------ docs/api/nidss_flu.md | 89 +++++++++------ docs/api/norostat.md | 87 +++++++++------ docs/api/norostat_meta.md | 87 +++++++++------ docs/api/paho_dengue.md | 81 +++++++++----- docs/api/quidel.md | 89 +++++++++------ docs/api/twitter.md | 89 +++++++++------ docs/api/wiki.md | 89 +++++++++------ 31 files changed, 1494 insertions(+), 818 deletions(-) diff --git a/docs/api/01meta.md b/docs/api/01meta.md index 7ecd67387..994a77fcf 100644 --- a/docs/api/01meta.md +++ b/docs/api/01meta.md @@ -111,16 +111,14 @@ None. Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch API metadata. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_meta() -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -135,39 +133,32 @@ epidata = EpiDataContext() res = epidata.pub_meta() print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_meta() +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$meta() -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -183,3 +174,35 @@ from delphi_epidata import Epidata res = Epidata.meta() print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$meta() +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/README.md b/docs/api/README.md index b12cabc24..73de62dce 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -204,7 +204,7 @@ The parameters available for each source are documented in each linked source-sp # Code Samples -To access our Epidata API, visit our [Epidata API Client Libraries)](client_libraries.md). For anyone looking for COVIDCast data in particular, please visit our purpose-built [COVIDCast Libraries](covidcast_clients.md) instead. +To access our Epidata API, visit our [Epidata API Client Libraries](client_libraries.md). For anyone looking for COVIDCast data in particular, please visit our purpose-built [COVIDCast Libraries](covidcast_clients.md) instead. # Related Work diff --git a/docs/api/cdc.md b/docs/api/cdc.md index 824c6a1ef..72b3288e0 100644 --- a/docs/api/cdc.md +++ b/docs/api/cdc.md @@ -107,16 +107,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch CDC data for national level for epiweek `201501`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pvt_cdc(auth = 'auth_token', locations = 'nat', epiweeks = 201501) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -131,39 +129,32 @@ epidata = EpiDataContext() res = epidata.pvt_cdc(auth='auth_token', locations=['nat'], epiweeks=[201501]) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pvt_cdc(auth = 'auth_token', locations = 'nat', epiweeks = 201501) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$cdc(auth = "auth_token", epiweeks = list(201501), locations = list("nat")) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -179,3 +170,35 @@ from delphi_epidata import Epidata res = Epidata.cdc('auth_token', [201501], ['nat']) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$cdc(auth = "auth_token", epiweeks = list(201501), locations = list("nat")) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/client_libraries.md b/docs/api/client_libraries.md index d97216fb3..6e8193c65 100644 --- a/docs/api/client_libraries.md +++ b/docs/api/client_libraries.md @@ -17,22 +17,14 @@ The following samples show how to import the library and fetch Delphi's COVID-19 Surveillance Streams from Facebook Survey CLI for county 06001 and days `20200401` and `20200405-20200414` (11 days total). -### R +
+
+ + -Install [`epidatr` from CRAN](https://cran.r-project.org/package=epidatr) -with `install.packages("epidatr")`. - -```r -# Configure API key interactively, if needed. See -# https://cmu-delphi.github.io/epidatr/articles/epidatr.html#api-keys for details. -#save_api_key() -library(epidatr) -data <- pub_covidcast('fb-survey', 'smoothed_cli', 'county', 'day', geo_values = '06001', - time_values = c(20200401, 20200405:20200414)) -print(data) -``` +
-### Python +
The `epidatpy` package will soon be [available on PyPI as `epidatpy`](https://pypi.org/project/epidatpy/). Meanwhile, it can be [installed from GitHub](https://github.com/cmu-delphi/epidatpy/) with @@ -56,19 +48,25 @@ apicall = epidata.pub_covidcast( ) print(apicall.df()) ``` +
-Install [`delphi-epidata` from PyPI](https://pypi.org/project/delphi-epidata/) with -`pip install delphi-epidata`. +
-```python -from delphi_epidata import Epidata -# Configure API key, if needed. -#Epidata.auth = ('epidata', ) -res = Epidata.covidcast('fb-survey', 'smoothed_cli', 'day', 'county', [20200401, Epidata.range(20200405, 20200414)], '06001') -print(res['result'], res['message'], len(res['epidata'])) +Install [`epidatr` from CRAN](https://cran.r-project.org/package=epidatr) +with `install.packages("epidatr")`. + +```r +# Configure API key interactively, if needed. See +# https://cmu-delphi.github.io/epidatr/articles/epidatr.html#api-keys for details. +#save_api_key() +library(epidatr) +data <- pub_covidcast('fb-survey', 'smoothed_cli', 'county', 'day', geo_values = '06001', + time_values = c(20200401, 20200405:20200414)) +print(data) ``` +
-### JavaScript (in a web browser) +
The minimalist JavaScript client does not currently support API keys. If you need API key support in JavaScript, contact delphi-support+privacy@andrew.cmu.edu. @@ -92,8 +90,33 @@ If you need API key support in JavaScript, contact delphi-support+privacy@andrew }); ``` +
+
+ +### Legacy Clients -### R (legacy) +
+
+ + + +
+ +
+ +Install [`delphi-epidata` from PyPI](https://pypi.org/project/delphi-epidata/) with +`pip install delphi-epidata`. + +```python +from delphi_epidata import Epidata +# Configure API key, if needed. +#Epidata.auth = ('epidata', ) +res = Epidata.covidcast('fb-survey', 'smoothed_cli', 'day', 'county', [20200401, Epidata.range(20200405, 20200414)], '06001') +print(res['result'], res['message'], len(res['epidata'])) +``` +
+ +
The old Delphi Epidata R client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), @@ -106,3 +129,33 @@ source('delphi_epidata.R') res <- Epidata$covidcast('fb-survey', 'smoothed_cli', 'day', 'county', list(20200401, Epidata$range(20200405, 20200414)), '06001') cat(paste(res$result, res$message, length(res$epidata), "\n")) ``` +
+ +
+ + The minimalist JavaScript client does not currently support API keys. + If you need API key support in JavaScript, contact delphi-support+privacy@andrew.cmu.edu. + + ```html + + + ``` +
+ +
+ diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md index fa625a997..9c9a0e03f 100644 --- a/docs/api/covid_hosp.md +++ b/docs/api/covid_hosp.md @@ -227,16 +227,13 @@ Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Pyth The following sample shows how to import the library and fetch MA on 2020-05-10 (per most recent issue). -### R +
+
+ + +
-```R -library(epidatr) -# Fetch data -res <- pub_covid_hosp_state_timeseries(states = "MA", dates = 20200510) -print(res) -``` - -### Python +
Install the package using pip: ```bash @@ -251,24 +248,31 @@ epidata = EpiDataContext() res = epidata.pub_covid_hosp(states="MA", dates=20200510) print(res) ``` +
-### Legacy Clients - -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). - -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. +
```R -source("delphi_epidata.R") +library(epidatr) # Fetch data -res <- Epidata$covid_hosp(states = list("MA"), dates = list(20200510)) -print(res$message) -print(length(res$epidata)) +res <- pub_covid_hosp_state_timeseries(states = "MA", dates = 20200510) +print(res) ``` +
+ +
+ +### Legacy Clients + +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +
+
+ + +
-#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -306,3 +310,19 @@ The following issues were repaired: These issues had been imported using the wrong column order due to an imprecise database migration. If you pulled these issues before January 22, you will want to discard that data. +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$covid_hosp(states = list("MA"), dates = list(20200510)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
diff --git a/docs/api/covid_hosp_facility.md b/docs/api/covid_hosp_facility.md index 85a7efff0..2ba1942e3 100644 --- a/docs/api/covid_hosp_facility.md +++ b/docs/api/covid_hosp_facility.md @@ -212,16 +212,13 @@ The following sample shows how to import the library and fetch Moses Taylor Hospital (Scranton, PA) on the first collection week of December 2020 (per most recent issue). -### R +
+
+ + +
-```R -library(epidatr) -# Fetch data -res <- pub_covid_hosp_facility(hospital_pks = "390119", collection_weeks = epirange(20201201, 20201207)) -print(res) -``` - -### Python +
Install the package using pip: ```bash @@ -236,24 +233,31 @@ epidata = EpiDataContext() res = epidata.pub_covid_hosp_facility(hospital_pks="390119", collection_weeks=EpiRange(20201201, 20201207)) print(res) ``` +
-### Legacy Clients - -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). - -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. +
```R -source("delphi_epidata.R") +library(epidatr) # Fetch data -res <- Epidata$covid_hosp_facility(hospital_pks = list("390119"), collection_weeks = list(Epidata$range(20201201, 20201207))) -print(res$message) -print(length(res$epidata)) +res <- pub_covid_hosp_facility(hospital_pks = "390119", collection_weeks = epirange(20201201, 20201207)) +print(res) ``` +
+ +
+ +### Legacy Clients + +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +
+
+ + +
-#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -269,3 +273,19 @@ from delphi_epidata import Epidata res = Epidata.covid_hosp_facility('390119', Epidata.range(20201201, 20201207)) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$covid_hosp_facility(hospital_pks = list("390119"), collection_weeks = list(Epidata$range(20201201, 20201207))) +print(res$message) +print(length(res$epidata)) +``` +
+ +
diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md index cb20a52f8..893a00f05 100644 --- a/docs/api/covid_hosp_facility_lookup.md +++ b/docs/api/covid_hosp_facility_lookup.md @@ -130,16 +130,13 @@ Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Pyth The following sample shows how to import the library and fetch facilities in the city of Southlake (TX). -### R +
+
+ + +
-```R -library(epidatr) -# Fetch data -res <- pub_covid_hosp_facility_lookup(city = "southlake") -print(res) -``` - -### Python +
Install the package using pip: ```bash @@ -154,24 +151,31 @@ epidata = EpiDataContext() res = epidata.pub_covid_hosp_facility_lookup(city="southlake") print(res) ``` +
-### Legacy Clients - -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). - -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. +
```R -source("delphi_epidata.R") +library(epidatr) # Fetch data -res <- Epidata$covid_hosp_facility_lookup(city = "southlake") -print(res$message) -print(length(res$epidata)) +res <- pub_covid_hosp_facility_lookup(city = "southlake") +print(res) ``` +
+ +
+ +### Legacy Clients + +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +
+
+ + +
-#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -187,3 +191,19 @@ from delphi_epidata import Epidata res = Epidata.covid_hosp_facility_lookup(city='southlake') print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$covid_hosp_facility_lookup(city = "southlake") +print(res$message) +print(length(res$epidata)) +``` +
+ +
diff --git a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md index a3c8eab5a..56a0763ce 100644 --- a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -788,12 +788,11 @@ of zero, and in simulations improves the quality of the standard error estimates. See the [Appendix](#appendix) for further motivation for these estimators. -
Note: -Currently the standard errors are calculated as though all survey weights are -equal, that is \(w^\text{part}_i = 1\) for all respondents. The result is that -reported standard errors are artificially narrow for weighted estimates. This -will be corrected in a future update to the API. -
+> **Note:** Currently the standard errors are calculated as though all survey weights are +> equal, that is $$w^\text{part}_i = 1$$ for all respondents. The result is that +> reported standard errors are artificially narrow for weighted estimates. This +> will be corrected in a future update to the API. +{: .note } The pseudo-observation is not used in $$\hat{p}$$ and $$\hat{q}$$ themselves, to avoid potentially large amounts of estimation bias, as $$p$$ and $$q$$ are diff --git a/docs/api/covidcast.md b/docs/api/covidcast.md index d22f63fab..fa46dffda 100644 --- a/docs/api/covidcast.md +++ b/docs/api/covidcast.md @@ -46,16 +46,15 @@ CSV file. Several [API clients are available](covidcast_clients.md) for common programming languages, so you do not need to construct API calls yourself to obtain COVIDcast data. Once you install the appropriate client for your programming -language, accessing data is as easy as, in [R](https://www.r-project.org/): +language, accessing data is as easy as: -```r -library(epidatr) +
+
+ + +
-data <- pub_covidcast('fb-survey', 'smoothed_cli', 'county', 'day', geo_values = '06001', - time_values = c(20200401, 20200405:20200414)) -``` - -or, in [Python](https://www.python.org): +
```python from epidatpy import EpiDataContext, EpiRange @@ -71,6 +70,18 @@ apicall = epidata.pub_covidcast( ) data = apicall.df() ``` +
+ +
+ +```r +library(epidatr) + +data <- pub_covidcast('fb-survey', 'smoothed_cli', 'county', 'day', geo_values = '06001', + time_values = c(20200401, 20200405:20200414)) +``` +
+
[The API clients](covidcast_clients.md) have extensive documentation providing further examples. diff --git a/docs/api/covidcast_meta.md b/docs/api/covidcast_meta.md index be77d73e1..0f006abe9 100644 --- a/docs/api/covidcast_meta.md +++ b/docs/api/covidcast_meta.md @@ -80,20 +80,14 @@ Python and R users are advised to use the dedicated API client, which provides s Alternatively, libraries are available for [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). The following samples show how to import the library and fetch Delphi's COVID-19 Surveillance Streams metadata. -### JavaScript (in a web browser) +
+
+ + + +
-````html - - - - -```` - -### Python +
Optionally install the package using pip(env): ````bash @@ -109,8 +103,9 @@ from delphi_epidata import Epidata res = Epidata.covidcast_meta() print(res['result'], res['message'], len(res['epidata'])) ```` +
-### R +
````R # Import @@ -119,3 +114,20 @@ source('delphi_epidata.R') res <- Epidata$covidcast_meta() cat(paste(res$result, res$message, length(res$epidata), "\n")) ```` +
+ +
+ +````html + + + + +```` +
+ +
diff --git a/docs/api/delphi.md b/docs/api/delphi.md index 81b422a97..c82c8884e 100644 --- a/docs/api/delphi.md +++ b/docs/api/delphi.md @@ -166,16 +166,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch Delphi Forecast data for system `ec` on epiweek `201501`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_delphi(system = 'ec', epiweek = 201501) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -190,39 +188,32 @@ epidata = EpiDataContext() res = epidata.delphi('ec', 201501) print(res['result'], res['message'], len(res['epidata'])) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_delphi(system = 'ec', epiweek = 201501) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$delphi(system = 'ec', epiweek = 201501) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -237,3 +228,35 @@ from delphi_epidata import Epidata res = Epidata.delphi('ec', 201501) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$delphi(system = 'ec', epiweek = 201501) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/dengue_digital_surveillance.md b/docs/api/dengue_digital_surveillance.md index 5a6d05381..661747a3c 100644 --- a/docs/api/dengue_digital_surveillance.md +++ b/docs/api/dengue_digital_surveillance.md @@ -92,16 +92,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch Dengue Sensors data for Puerto Rico for epiweek `201501`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pvt_dengue_sensors(auth = 'auth_token', names = 'ght', locations = 'pr', epiweeks = 201501) -print(res) -``` +
-### Python +
Install the package using pip: @@ -117,39 +115,33 @@ epidata = EpiDataContext() res = epidata.dengue_sensors('auth_token', ['ght'], ['pr'], [201501]) print(res['result'], res['message'], len(res['epidata'])) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pvt_dengue_sensors(auth = 'auth_token', names = 'ght', locations = 'pr', epiweeks = 201501) +print(res) ``` +
+ +
### Legacy Clients We recommend using our client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. +
+
+ + + +
-```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$dengue_sensors(auth = "auth_token", sensors = list("gft"), locations = list("pr"), epiweeks = list(201501)) -print(res$message) -print(length(res$epidata)) -``` +
-#### Python (Legacy) Optionally install the package using pip(env): ```bash pip install delphi-epidata @@ -162,3 +154,35 @@ from delphi_epidata import Epidata res = Epidata.dengue_sensors('auth_token', ['gft'], ['pr'], [201501]) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$dengue_sensors(auth = "auth_token", sensors = list("gft"), locations = list("pr"), epiweeks = list(201501)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/dengue_nowcast.md b/docs/api/dengue_nowcast.md index 0f5542496..aaf962948 100644 --- a/docs/api/dengue_nowcast.md +++ b/docs/api/dengue_nowcast.md @@ -88,16 +88,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch Dengue Nowcast data for Puerto Rico for epiweeks `201401` to `202301`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_dengue_nowcast(locations = 'pr', epiweeks = epirange(201401, 202301)) -print(res) -``` +
-### Python +
Install the package using pip: @@ -113,39 +111,32 @@ epidata = EpiDataContext() res = epidata.dengue_nowcast(['pr'], EpiRange(201401, 202301)) print(res['result'], res['message'], len(res['epidata'])) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_dengue_nowcast(locations = 'pr', epiweeks = epirange(201401, 202301)) +print(res) ``` +
+ +
### Legacy Clients For modern clients, we recommend using [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following clients are considered legacy: [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$dengue_nowcast(locations = list("pr"), epiweeks = list(201501)) -print(res$message) -print(length(res$epidata)) -``` +
+
+ + + +
-#### Python (Legacy) +
Optionally install the package using pip(env): @@ -155,10 +146,42 @@ pip install delphi-epidata Otherwise, place `delphi_epidata.py` from this repo next to your python script. -````python +```python # Import from delphi_epidata import Epidata # Fetch data res = Epidata.dengue_nowcast(['pr'], [201501]) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$dengue_nowcast(locations = list("pr"), epiweeks = list(201501)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index c48061184..f03c7eaec 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -104,18 +104,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch national Delphi's Digital Surveillance SAR3 Sensor data for epiweeks `201501-202001`. +
+
+ + -### R +
-```R -library(epidatr) -# Fetch data -res <- pvt_sensors(auth = 'SECRET_API_AUTH_SENSORS', locations = 'nat', -names = 'sar3', epiweeks = epirange(201501, 202001)) -print(res) -``` - -### Python +
Install the package using pip: @@ -131,39 +127,35 @@ epidata = EpiDataContext() res = epidata.sensors(['nat'], ['sar3'], EpiRange(201501, 202001)) print(res['result'], res['message'], len(res['epidata'])) ``` +
-### JavaScript (in a web browser) +
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). - -```html - - - - +```R +library(epidatr) +# Fetch data +res <- pvt_sensors(auth = 'SECRET_API_AUTH_SENSORS', locations = 'nat', +names = 'sar3', epiweeks = epirange(201501, 202001)) +print(res) ``` +
-### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
-Place `delphi_epidata.R` from this repo next to your R script. +### Legacy Clients -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$sensors(locations = list("nat"), sensors = list("sar3"), epiweeks = Epidata$range(201501, 202001)) -print(res$message) -print(length(res$epidata)) -``` +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). + +
+
+ + + +
-#### Python (Legacy) +
Optionally install the package using pip(env): @@ -180,3 +172,35 @@ from delphi_epidata import Epidata res = Epidata.sensors(['nat'], ['sar3'], Epidata.range(201501, 202001)) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$sensors(locations = list("nat"), sensors = list("sar3"), epiweeks = Epidata$range(201501, 202001)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index b060babb5..d4262480b 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -108,16 +108,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch ECDC ILI data for Austria for epiweeks `202001` and `202002`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_ecdc_ili(regions = 'austria', epiweeks = c(202001, 202002)) -print(res) -``` +
-### Python +
Install the package using pip: @@ -133,39 +131,32 @@ epidata = EpiDataContext() res = epidata.ecdc_ili(['austria'], [202001, 202002]) print(res['result'], res['message'], len(res['epidata'])) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_ecdc_ili(regions = 'austria', epiweeks = c(202001, 202002)) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$ecdc_ili(regions = list("austria"), epiweeks = list(202001, 202002)) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): @@ -182,3 +173,35 @@ from delphi_epidata import Epidata res = Epidata.ecdc_ili(['austria'], [202001, 202002]) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$ecdc_ili(regions = list("austria"), epiweeks = list(202001, 202002)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index f505c121a..1a1d78df1 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -154,16 +154,13 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch CA FluView Clinical data for epiweeks `201701-201801`. -### R +
+
+ + +
-```R -library(epidatr) -# Fetch data -res <- pub_flusurv(locations = "CA", epiweeks = epirange(201701, 201801)) -print(res) -``` - -### Python +
Install the package using pip: ```bash @@ -178,8 +175,19 @@ epidata = EpiDataContext() res = epidata.pub_flusurv(locations="CA", epiweeks=EpiRange(201701, 201801)) print(res) ``` +
+ +
+ +```R +library(epidatr) +# Fetch data +res <- pub_flusurv(locations = "CA", epiweeks = epirange(201701, 201801)) +print(res) +``` +
-### JavaScript (in a web browser) +
The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). @@ -193,24 +201,22 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e }); ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$flusurv(locations = list("CA"), epiweeks = list(Epidata$range(201701, 201801))) -print(res$message) -print(length(res$epidata)) -``` +
+
+ + + +
-#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -226,4 +232,35 @@ from delphi_epidata import Epidata res = Epidata.flusurv(['CA'], [Epidata.range(201701, 201801)]) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$flusurv(locations = list("CA"), epiweeks = list(Epidata$range(201701, 201801))) +print(res$message) +print(length(res$epidata)) ``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/fluview.md b/docs/api/fluview.md index 4ebfbe659..9ea666a73 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -137,17 +137,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch national FluView data for epiweeks `201501-201510`. +
+
+ + -### R +
-```R -library(epidatr) -# Fetch data -res <- pub_fluview(regions = "nat", epiweeks = epirange(201501, 201510)) -print(res) -``` - -### Python +
Install the package using pip: ```bash @@ -162,8 +159,19 @@ epidata = EpiDataContext() res = epidata.pub_fluview(regions="nat", epiweeks=EpiRange(201501, 201510)) print(res) ``` +
+ +
+ +```R +library(epidatr) +# Fetch data +res <- pub_fluview(regions = "nat", epiweeks = epirange(201501, 201510)) +print(res) +``` +
-### JavaScript (in a web browser) +
The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). @@ -173,28 +181,19 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e -``` +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. +
+
+ + +
-```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$fluview(regions = list("nat"), epiweeks = list(Epidata$range(201501, 201510))) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -210,3 +209,35 @@ from delphi_epidata import Epidata res = Epidata.fluview(['nat'], [Epidata.range(201501, 201510)]) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$fluview(regions = list("nat"), epiweeks = list(Epidata$range(201501, 201510))) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index cccd68bad..f5480fb2b 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -115,16 +115,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch national FluView Clinical data for epiweeks `201601-201701`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_fluview_clinical(regions = "nat", epiweeks = epirange(201601, 201701)) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -138,39 +136,32 @@ from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange res = Epidata.fluview_clinical(['nat'], [Epidata.range(201601, 201701)]) print(res['result'], res['message'], len(res['epidata'])) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_fluview_clinical(regions = "nat", epiweeks = epirange(201601, 201701)) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$fluview_clinical(regions = list("nat"), epiweeks = list(Epidata$range(201601, 201701))) -print(res$message) -print(length(res$epidata)) -``` +
+
+ + + +
-#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -186,3 +177,35 @@ from delphi_epidata import Epidata res = Epidata.fluview_clinical(['nat'], [Epidata.range(201601, 201701)]) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$fluview_clinical(regions = list("nat"), epiweeks = list(Epidata$range(201601, 201701))) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ + The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + + ```html + + + + + ``` +
+ +
diff --git a/docs/api/fluview_meta.md b/docs/api/fluview_meta.md index 86f39294a..38ed36b7b 100644 --- a/docs/api/fluview_meta.md +++ b/docs/api/fluview_meta.md @@ -82,16 +82,13 @@ There are no parameters for this endpoint. Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch FluView metadata. -### R +
+
+ + +
-```R -library(epidatr) -# Fetch data -res <- pub_fluview_meta() -print(res) -``` - -### Python +
```python # Import @@ -101,3 +98,16 @@ epidata = EpiDataContext() res = epidata.pub_fluview_meta() print(res) ``` +
+ +
+ +```R +library(epidatr) +# Fetch data +res <- pub_fluview_meta() +print(res) +``` +
+ +
diff --git a/docs/api/gft.md b/docs/api/gft.md index 232d5c732..c02097c6a 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -86,16 +86,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch Google Flu Trends data for epiweeks `201501-201510`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_gft(locations = 'nat', epiweeks = epirange(201501, 201510)) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -110,39 +108,32 @@ epidata = EpiDataContext() res = epidata.pub_gft(locations='nat', epiweeks=EpiRange(201501, 201510)) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_gft(locations = 'nat', epiweeks = epirange(201501, 201510)) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$gft(locations = list("nat"), epiweeks = Epidata$range(201501, 201510)) -print(res$message) -print(length(res$epidata)) -``` +
+
+ + + +
-#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -158,3 +149,35 @@ from delphi_epidata import Epidata res = Epidata.gft(['nat'], Epidata.range(201501, 201510)) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$gft(locations = list("nat"), epiweeks = Epidata$range(201501, 201510)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/ght.md b/docs/api/ght.md index f6556a2c1..6dd0da4cf 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -95,17 +95,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch GHT data for "how to get over the flu" in the US for epiweek `201501`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pvt_ght(auth = 'auth_token', locations = 'US', epiweeks = 201501, - query = "how to get over the flu") -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -120,39 +117,33 @@ epidata = EpiDataContext() res = epidata.ght('auth_token', ['US'], [201501], 'how to get over the flu') print(res['result'], res['message'], len(res['epidata'])) ``` +
-### JavaScript (in a web browser) +
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). - -```html - - - - +```R +library(epidatr) +# Fetch data +res <- pvt_ght(auth = 'auth_token', locations = 'US', epiweeks = 201501, + query = "how to get over the flu") +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$ght(auth = "auth_token", locations = list("US"), epiweeks = list(201501), query = "how to get over the flu") -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -168,3 +159,35 @@ from delphi_epidata import Epidata res = Epidata.ght('auth_token', ['US'], [201501], 'how to get over the flu') print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$ght(auth = "auth_token", locations = list("US"), epiweeks = list(201501), query = "how to get over the flu") +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index 05ebac0ed..10d2b850f 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -95,16 +95,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch national ILI Nearby data for epiweeks `202001-202010` (10 weeks total). -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_nowcast(locations = 'nat', epiweeks = epirange(202001, 202010)) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -119,39 +117,32 @@ epidata = EpiDataContext() res = epidata.pub_nowcast(locations=['nat'], epiweeks=EpiRange(202001, 202010)) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_nowcast(locations = 'nat', epiweeks = epirange(202001, 202010)) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$nowcast(locations = list("nat"), epiweeks = Epidata$range(202001, 202010)) -print(res$message) -print(length(res$epidata)) -``` +
+
+ + + +
-#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -166,4 +157,37 @@ from delphi_epidata import Epidata # Fetch data res = Epidata.nowcast(['nat'], Epidata.range(202001, 202010)) print(res['result'], res['message'], len(res['epidata'])) +``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$nowcast(locations = list("nat"), epiweeks = Epidata$range(202001, 202010)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
``` diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index 7a26423bd..d6aecee7a 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -108,16 +108,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch KCDC ILI data for ROK for epiweeks `202001` and `202002`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_kcdc_ili(regions = 'ROK', epiweeks = c(202001, 202002)) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -132,39 +130,32 @@ epidata = EpiDataContext() res = epidata.pub_kcdc_ili(regions=['ROK'], epiweeks=[202001, 202002]) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_kcdc_ili(regions = 'ROK', epiweeks = c(202001, 202002)) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$kcdc_ili(regions = list("ROK"), epiweeks = list(202001, 202002)) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -180,3 +171,35 @@ from delphi_epidata import Epidata res = Epidata.kcdc_ili(['ROK'], [202001, 202002]) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$kcdc_ili(regions = list("ROK"), epiweeks = list(202001, 202002)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 6cfd0ee6c..6d9ccef46 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -88,16 +88,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch national NIDSS Dengue data for epiweeks `201501-201510` (10 weeks total). -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_nidss_dengue(locations = 'nationwide', epiweeks = epirange(201501, 201510)) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -112,39 +110,32 @@ epidata = EpiDataContext() res = epidata.pub_nidss_dengue(locations=['nationwide'], epiweeks=EpiRange(201501, 201510)) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_nidss_dengue(locations = 'nationwide', epiweeks = epirange(201501, 201510)) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$nidss_dengue(regions = list("nationwide"), epiweeks = Epidata$range(201501, 201510)) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -163,4 +154,36 @@ print(res['result'], res['message'], len(res['epidata'])) # Source and Licensing -The full text of the NIDSS Dengue license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license). \ No newline at end of file +The full text of the NIDSS Dengue license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license). +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$nidss_dengue(regions = list("nationwide"), epiweeks = Epidata$range(201501, 201510)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index bd6132096..7a70a014e 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -108,16 +108,14 @@ If neither is specified, the current issues are used. Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch national NIDSS Flu data for epiweeks `201501-201510` (10 weeks total). -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_nidss_flu(regions = 'nationwide', epiweeks = epirange(201501, 201510)) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -132,39 +130,32 @@ epidata = EpiDataContext() res = epidata.pub_nidss_flu(regions=['nationwide'], epiweeks=EpiRange(201501, 201510)) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_nidss_flu(regions = 'nationwide', epiweeks = epirange(201501, 201510)) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$nidss_flu(regions = list("nationwide"), epiweeks = Epidata$range(201501, 201510)) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -183,4 +174,36 @@ print(res['result'], res['message'], len(res['epidata'])) # Source and Licensing -The full text of the NIDSS Flu license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license). \ No newline at end of file +The full text of the NIDSS Flu license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license). +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$nidss_flu(regions = list("nationwide"), epiweeks = Epidata$range(201501, 201510)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/norostat.md b/docs/api/norostat.md index 38395f8ad..fd6a9f70b 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.md @@ -89,16 +89,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch NoroSTAT data for the most recent available states for epiweek `201501`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pvt_norostat(auth = 'auth_token', locations = 'Minnesota, Ohio, Oregon, Tennessee, and Wisconsin', epiweeks = 201501) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -113,39 +111,32 @@ epidata = EpiDataContext() res = epidata.pvt_norostat(auth='auth_token', locations=['Minnesota, Ohio, Oregon, Tennessee, and Wisconsin'], epiweeks=[201501]) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pvt_norostat(auth = 'auth_token', locations = 'Minnesota, Ohio, Oregon, Tennessee, and Wisconsin', epiweeks = 201501) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$norostat(auth = "auth_token", locations = list("Minnesota, Ohio, Oregon, Tennessee, and Wisconsin"), epiweeks = list(201501)) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -161,3 +152,35 @@ from delphi_epidata import Epidata res = Epidata.norostat('auth_token', ['Minnesota, Ohio, Oregon, Tennessee, and Wisconsin'], [201501]) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$norostat(auth = "auth_token", locations = list("Minnesota, Ohio, Oregon, Tennessee, and Wisconsin"), epiweeks = list(201501)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/norostat_meta.md b/docs/api/norostat_meta.md index c18b77621..64dde10ac 100644 --- a/docs/api/norostat_meta.md +++ b/docs/api/norostat_meta.md @@ -98,16 +98,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch NoroSTAT Metadata. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pvt_meta_norostat(auth = 'auth_token') -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -122,39 +120,32 @@ epidata = EpiDataContext() res = epidata.pvt_meta_norostat(auth='auth_token') print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pvt_meta_norostat(auth = 'auth_token') +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$meta_norostat(auth = "auth_token") -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -170,3 +161,35 @@ from delphi_epidata import Epidata res = Epidata.meta_norostat('auth_token') print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$meta_norostat(auth = "auth_token") +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index 16173bb8f..2a6d266b1 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -104,16 +104,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch PAHO Dengue data for Canada for epiweek `201501`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_paho_dengue(regions = 'ca', epiweeks = 201501) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -128,27 +126,45 @@ epidata = EpiDataContext() res = epidata.pub_paho_dengue(regions=['ca'], epiweeks=[201501]) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_paho_dengue(regions = 'ca', epiweeks = 201501) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
+ +
+ +Place `delphi_epidata.py` from this repo next to your python script. + +```python +# Import +from delphi_epidata import Epidata +# Fetch data +res = Epidata.paho_dengue(['ca'], [201501]) +print(res['result'], res['message'], len(res['epidata'])) +``` +
+ +
Place `delphi_epidata.R` from this repo next to your R script. @@ -159,15 +175,22 @@ res <- Epidata$paho_dengue(regions = list("ca"), epiweeks = list(201501)) print(res$message) print(length(res$epidata)) ``` +
-#### Python (Legacy) +
-Place `delphi_epidata.py` from this repo next to your python script. +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). -```python -# Import -from delphi_epidata import Epidata -# Fetch data -res = Epidata.paho_dengue(['ca'], [201501]) -print(res['result'], res['message'], len(res['epidata'])) +```html + + + + ``` +
+ +
diff --git a/docs/api/quidel.md b/docs/api/quidel.md index 0112134ec..d1a35331f 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -90,16 +90,14 @@ See this [documentation](https://cmu-delphi.github.io/delphi-epidata/api/README. Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch Quidel data for HHS Region 1 for epiweeks `201535-202001`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pvt_quidel(auth = 'auth_token', locations = 'hhs1', epiweeks = epirange(201535, 202001)) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -114,39 +112,32 @@ epidata = EpiDataContext() res = epidata.pvt_quidel(auth='auth_token', locations=['hhs1'], epiweeks=EpiRange(201535, 202001)) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pvt_quidel(auth = 'auth_token', locations = 'hhs1', epiweeks = epirange(201535, 202001)) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) - -Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$quidel(auth = "auth_token", locations = list("hhs1"), epiweeks = Epidata$range(201535, 202001)) -print(res$message) -print(length(res$epidata)) -``` +
+
+ + + +
-#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -161,4 +152,36 @@ from delphi_epidata import Epidata # Fetch data res = Epidata.quidel('auth_token', ['hhs1'], Epidata.range(201535, 202001)) print(res['result'], res['message'], len(res['epidata'])) -``` \ No newline at end of file +``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$quidel(auth = "auth_token", locations = list("hhs1"), epiweeks = Epidata$range(201535, 202001)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/twitter.md b/docs/api/twitter.md index 6614c435d..6c339af47 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -106,17 +106,14 @@ Researchers who use the Twitter Stream data for research are asked to credit and Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch Twitter data for national level for epiweek `201501`. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pvt_twitter(auth = 'auth_token', locations = 'nat', - time_type = "week", time_values = 201501) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -131,39 +128,33 @@ epidata = EpiDataContext() res = epidata.pvt_twitter(auth='auth_token', locations=['nat'], time_type="week", time_values=[201501]) print(res) ``` +
-### JavaScript (in a web browser) +
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). - -```html - - - - +```R +library(epidatr) +# Fetch data +res <- pvt_twitter(auth = 'auth_token', locations = 'nat', + time_type = "week", time_values = 201501) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$twitter(auth = "auth_token", locations = list("nat"), time_type = "week", time_values = list(201501)) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -179,3 +170,35 @@ from delphi_epidata import Epidata res = Epidata.twitter('auth_token', ['nat'], time_type="week", time_values=[201501]) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$twitter(auth = "auth_token", locations = list("nat"), time_type = "week", time_values = list(201501)) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
diff --git a/docs/api/wiki.md b/docs/api/wiki.md index beb38d45f..e5084808d 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -130,17 +130,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a Libraries are available for [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following samples show how to import the library and fetch Wikipedia Access data for article "influenza" in English for epiweeks `202001-202010` (10 weeks total) and hours 0 and 12. -### R +
+
+ + -```R -library(epidatr) -# Fetch data -res <- pub_wiki(articles = "influenza", time_values = epirange(202001, 202010), - time_type = "week", language = "en", hours = c(0, 12)) -print(res) -``` +
-### Python +
Install the package using pip: ```bash @@ -155,39 +152,33 @@ epidata = EpiDataContext() res = epidata.pub_wiki(articles=['influenza'], time_values=EpiRange(202001, 202010), time_type='week', language='en', hours=[0, 12]) print(res) ``` +
-### JavaScript (in a web browser) - -The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). +
-```html - - - - +```R +library(epidatr) +# Fetch data +res <- pub_wiki(articles = "influenza", time_values = epirange(202001, 202010), + time_type = "week", language = "en", hours = c(0, 12)) +print(res) ``` +
+ +
### Legacy Clients We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). -#### R (Legacy) +
+
+ + + +
-Place `delphi_epidata.R` from this repo next to your R script. - -```R -source("delphi_epidata.R") -# Fetch data -res <- Epidata$wiki(articles = list("influenza"), time_values = Epidata$range(202001, 202010), time_type = "week", options = list(language = "en", hours = list(0, 12))) -print(res$message) -print(length(res$epidata)) -``` - -#### Python (Legacy) +
Optionally install the package using pip(env): ```bash @@ -203,3 +194,35 @@ from delphi_epidata import Epidata res = Epidata.wiki(['influenza'], Epidata.range(202001, 202010), {'time_type': 'week', 'language': 'en', 'hours': [0, 12]}) print(res['result'], res['message'], len(res['epidata'])) ``` +
+ +
+ +Place `delphi_epidata.R` from this repo next to your R script. + +```R +source("delphi_epidata.R") +# Fetch data +res <- Epidata$wiki(articles = list("influenza"), time_values = Epidata$range(202001, 202010), time_type = "week", options = list(language = "en", hours = list(0, 12))) +print(res$message) +print(length(res$epidata)) +``` +
+ +
+ +The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + +```html + + + + +``` +
+ +
From ab3184f570560b940c8bd5c68b620e82b454f749 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Sun, 30 Nov 2025 21:08:06 -0800 Subject: [PATCH 43/64] docs: update headers for Other Endpoints with epiportal information. The last update was included for inactive endpoints. --- docs/api/cdc.md | 5 +- docs/api/client_libraries.md | 44 +++++++------- docs/api/covid_hosp.md | 2 +- docs/api/covid_hosp_facility.md | 4 +- docs/api/covid_hosp_facility_lookup.md | 2 +- docs/api/delphi.md | 5 +- docs/api/dengue_digital_surveillance.md | 4 +- docs/api/dengue_nowcast.md | 4 +- docs/api/digital_surveillance_sensors.md | 7 +-- docs/api/ecdc_ili.md | 4 +- docs/api/flusurv.md | 4 +- docs/api/fluview.md | 2 +- docs/api/fluview_clinical.md | 4 +- docs/api/fluview_meta.md | 4 +- docs/api/gft.md | 5 +- docs/api/ght.md | 9 ++- docs/api/ili_nearby_nowcast.md | 4 +- docs/api/kcdc_ili.md | 5 +- docs/api/nidss_dengue.md | 2 +- docs/api/nidss_flu.md | 2 +- docs/api/norostat.md | 5 +- docs/api/paho_dengue.md | 7 +-- docs/api/quidel.md | 8 +-- docs/api/twitter.md | 2 +- docs/api/wiki.md | 9 ++- docs/api/wiki_articles.md | 77 ++++++++++++++++++++++++ 26 files changed, 150 insertions(+), 80 deletions(-) create mode 100644 docs/api/wiki_articles.md diff --git a/docs/api/cdc.md b/docs/api/cdc.md index 72b3288e0..e080f450e 100644 --- a/docs/api/cdc.md +++ b/docs/api/cdc.md @@ -15,10 +15,10 @@ nav_order: 2 | **Data Source** | CDC influenza surveillance data | | **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2020w03 (2020-01-12) | | **Earliest Date** | 2013w02 (2013-01-06) | - + ## Overview {: .no_toc} @@ -37,7 +37,6 @@ General topics not specific to any particular endpoint are discussed in the {:toc} - # The API The base URL is: diff --git a/docs/api/client_libraries.md b/docs/api/client_libraries.md index 6e8193c65..dea8fad24 100644 --- a/docs/api/client_libraries.md +++ b/docs/api/client_libraries.md @@ -133,28 +133,28 @@ cat(paste(res$result, res$message, length(res$epidata), "\n"))
- The minimalist JavaScript client does not currently support API keys. - If you need API key support in JavaScript, contact delphi-support+privacy@andrew.cmu.edu. - - ```html - - - ``` +The minimalist JavaScript client does not currently support API keys. +If you need API key support in JavaScript, contact delphi-support+privacy@andrew.cmu.edu. + +```html + + +```
diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md index 9c9a0e03f..8fecb03f7 100644 --- a/docs/api/covid_hosp.md +++ b/docs/api/covid_hosp.md @@ -15,7 +15,7 @@ nav_order: 2 | **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) | | **Geographic Coverage** | US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | | **Temporal Resolution** | Daily | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2024-04-27 | | **Earliest Date** | 2020-01-01 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | diff --git a/docs/api/covid_hosp_facility.md b/docs/api/covid_hosp_facility.md index 2ba1942e3..eec828c0e 100644 --- a/docs/api/covid_hosp_facility.md +++ b/docs/api/covid_hosp_facility.md @@ -15,7 +15,7 @@ nav_order: 2 | **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) | | **Geographic Coverage** | Healthcare facility | | **Temporal Resolution** | Weekly (Friday -- Thursday) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2024w08 | | **Earliest Date** | 2020-07-31 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | @@ -62,7 +62,7 @@ See [this documentation](README.md) for details on specifying locations and date {: .note} -> **NOTEs:** +> **NOTES:** > - [`covid_hosp_facility_lookup` endpoint](covid_hosp_facility_lookup.md) can > be used to lookup facility identifiers in a variety of ways. > - A collection week spans Friday -- Thursday, and weeks are identified by > the date corresponding to the Friday at the start of the week. Therefore, the diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md index 893a00f05..20e3e7fa9 100644 --- a/docs/api/covid_hosp_facility_lookup.md +++ b/docs/api/covid_hosp_facility_lookup.md @@ -14,7 +14,7 @@ nav_order: 2 | **Source Name** | `covid_hosp_facility_lookup` | | **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) | | **Geographic Coverage** | Healthcare facility ([state](geographic_codes.html#us-states-and-territories), ccn city, zip, fips) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2024w08 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | - ## Overview {: .no_toc} diff --git a/docs/api/dengue_digital_surveillance.md b/docs/api/dengue_digital_surveillance.md index 661747a3c..4d42a3d20 100644 --- a/docs/api/dengue_digital_surveillance.md +++ b/docs/api/dengue_digital_surveillance.md @@ -16,8 +16,8 @@ permalink: api/dengue_sensors.html | **Data Source** | Various digital data streams | | **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | -| **Earliest Date** | 2003w01 | +| **Update Frequency** | Inactive - No longer updated since 2020w32| +| **Earliest Date** | 2014w04 | | **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | diff --git a/docs/api/dengue_nowcast.md b/docs/api/dengue_nowcast.md index aaf962948..ad9a71453 100644 --- a/docs/api/dengue_nowcast.md +++ b/docs/api/dengue_nowcast.md @@ -15,9 +15,9 @@ nav_order: 2 | **Data Source** | [Delphi](https://delphi.cmu.edu/) | | **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2020w32 | | **Earliest Date** | 2014w09 | -| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/ | +| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | ## Overview diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index f03c7eaec..647002565 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -15,11 +15,10 @@ permalink: api/sensors.html | **Data Source** | Various digital data streams | | **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2022w36 | +| **Earliest Date** | 2010w40 | | **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | - - This is the documentation of the API for accessing the Digital Surveillance Sensors (`sensors`) endpoint of the [Delphi](https://delphi.cmu.edu/)'s epidemiological data. @@ -29,7 +28,7 @@ General topics not specific to any particular endpoint are discussed in the [data licensing](README.md#data-licensing). {: .note} -> **Note:** this repository was built to support modelling and forecasting efforts +> **Note:** This repository was built to support modelling and forecasting efforts > surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic, > syndromic surveillance data, like ILI data (influenza-like illness) through > FluView, will likely prove very useful. However, **we urge caution to users diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index d4262480b..49fc47431 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -15,9 +15,9 @@ nav_order: 2 | **Data Source** | [European Centre for Disease Prevention and Control (ECDC)](https://www.ecdc.europa.eu/en/home) | | **Geographic Coverage** | European countries (see [Geographic Codes](geographic_codes.html#european-countries)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Weekly | +| **Update Frequency** | Inactive - No longer updated since 2020w12 | | **Earliest Date** | 2018w40 | -| **License** | Open Access | +| **License** | This was scraped from a publicly-accessible website, but no explicit license terms were found. | ## Overview diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index 1a1d78df1..03c533224 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -16,9 +16,9 @@ nav_order: 1 | **Geographic Coverage** | See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list | | **Temporal Resolution** | Weekly (Epiweek) | | **Earliest Date** | 2003w40 | +| **Update Frequency** | Weekly | +| **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | - diff --git a/docs/api/fluview.md b/docs/api/fluview.md index 9ea666a73..ef10a0e5a 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -17,7 +17,7 @@ nav_order: 1 | **Temporal Resolution** | Weekly (Epiweek) | | **Update Frequency** | Weekly (typically Fridays) | | **Earliest Date** | 1997w40 | -| **License** | Open Access / [CDC](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | +| **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | ## Overview {: .no_toc} diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index f5480fb2b..aba3d7852 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -15,9 +15,9 @@ nav_order: 1 | **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | | **Geographic Coverage** | National, HHS regions, states, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Weekly (typically Fridays) | +| **Update Frequency** | Weekly (typically Fridays) | | **Earliest Date** | 2016w40 | -| **License** | Open Access | +| **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | ## Overview diff --git a/docs/api/fluview_meta.md b/docs/api/fluview_meta.md index 38ed36b7b..4e98e5440 100644 --- a/docs/api/fluview_meta.md +++ b/docs/api/fluview_meta.md @@ -12,8 +12,8 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `fluview_meta` | | **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | -| **Update Frequency** | Weekly (typically Fridays) | -| **License** | Open Access | +| **Update Frequency** | Weekly (typically Fridays) | +| **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | ## Overview {: .no_toc} diff --git a/docs/api/gft.md b/docs/api/gft.md index c02097c6a..149277fae 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -15,9 +15,9 @@ nav_order: 2 | **Data Source** | [Google Flu Trends Estimates](https://www.google.com/publicdata/explore?ds=z3bsqef7ki44ac_) ([context](https://en.wikipedia.org/wiki/Google_Flu_Trends)) | | **Geographic Coverage** | National, HHS regions, US states (see [US Regions and States](geographic_codes.html#us-regions-and-states)), and select cities (see [Selected US Cities](geographic_codes.html#selected-us-cities)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2015w32 | | **Earliest Date** | 2003w40 | -| **License** | Open Access | +| **License** | [Google Terms of Service](https://policies.google.com/terms) | ## Overview @@ -34,6 +34,7 @@ General topics not specific to any particular endpoint are discussed in the {: .no_toc .text-delta} 1. TOC +{:toc} # The API diff --git a/docs/api/ght.md b/docs/api/ght.md index 6dd0da4cf..29a2ee528 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -14,11 +14,10 @@ nav_order: 2 | **Source Name** | `ght` | | **Data Source** | Google Health Trends | | **Geographic Coverage** | [US States](geographic_codes.html#us-states-and-territories) and national level (US) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | - - +| **Temporal Resolution** | Weekly (Epiweek) | +| **Update Frequency** | Inactive - No longer updated since 2022w36 | +| **Earliest Date** | 1993w01 | +| **License** | [Google Terms of Service](https://policies.google.com/terms) | This is the API documentation for accessing the Google Health Trends (`ght`) endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data. diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index 10d2b850f..902008bf5 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -17,8 +17,8 @@ permalink: api/nowcast.html | **Dataset Type** | Predictive (Leading Indicator) | | **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Released Friday; updated Sunday & Monday | -| **Earliest Date** | 2010w30 | +| **Update Frequency** | Inactive - No longer updated since 2022w36 | +| **Earliest Date** | 2010w45 | | **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | ## Overview diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index d6aecee7a..e1d1a0254 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -15,10 +15,9 @@ nav_order: 2 | **Data Source** | [Korea Disease Control and Prevention Agency (KCDC) ILI surveillance](https://www.kdca.go.kr/) | | **Geographic Coverage** | ROK (Republic of Korea) (see [Geographic Codes](geographic_codes.md#republic-of-korea)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2020w44 | | **Earliest Date** | 2004w36 | - - +| **License** | This was scraped from a publicly-accessible government website, but no explicit license terms were found. | ## Overview {: .no_toc} diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 6d9ccef46..3c0daabff 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -15,7 +15,7 @@ nav_order: 2 | **Data Source** | [Taiwan CDC](http://nidss.cdc.gov.tw/en/SingleDisease.aspx?dc=1&dt=4&disease=061&position=1)| | **Geographic Coverage** | Taiwan regions and cities/counties (see [Geographic Codes](geographic_codes.html#nidss)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2018w10 | | **Earliest Date** | 2003w01 | | **License** | [Open Access](https://data.gov.tw/license) | diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index 7a70a014e..ef97e8003 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -15,7 +15,7 @@ nav_order: 2 | **Source** | [Taiwan CDC](http://nidss.cdc.gov.tw/en/CDCWNH01.aspx?dc=wnh) | | **Geographic Coverage** | Taiwan regions (see [Geographic Codes](geographic_codes.html#taiwan-regions)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2018w10 | | **Earliest Date** | 2008w14 | | **License** | [Open Access](https://data.gov.tw/license) | diff --git a/docs/api/norostat.md b/docs/api/norostat.md index fd6a9f70b..ce6c37df8 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.md @@ -16,10 +16,9 @@ nav_order: 2 | **Dataset Type** | Surveillance (Inactive) | | **Geographic Coverage** | Only a specific list of full state names are permitted. See the `locations` output of the [meta_norostat](meta_norostat.html#norostat-metadata-1) endpoint for the allowed values. | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - Delphi stopped stopped acquiring data from this data source in November 2020. | +| **Update Frequency** | Inactive - No longer updated since 2020w30. | | **Earliest Date** | 2012w31 | - - +| **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | ## Overview {: .no_toc} diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index 2a6d266b1..552a1ba16 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -15,10 +15,9 @@ nav_order: 2 | **Data Source** | [Pan American Health Organization (PAHO) Dengue surveillance](https://www.paho.org/en/arbo-portal/dengue-data-and-analysis) | | **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | - - - +| **Update Frequency** | Inactive - No longer updated since 2020w31 | +| **Earliest Date** | 2014w01 | +| **License** | This was scraped from a publicly-accessible website, but no explicit license terms were found. | ## Overview {: .no_toc} diff --git a/docs/api/quidel.md b/docs/api/quidel.md index d1a35331f..fc4de0b21 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -12,13 +12,13 @@ nav_order: 2 | Attribute | Details | | :--- | :--- | | **Source Name** | `quidel` | -| **Data Source** | Quidel influenza testing data | +| **Data Source** | QuidelOrtho Corp. influenza testing data | | **Geographic Coverage** | HHS regions (see [Geographic Codes](geographic_codes.html#hhs-regions)) | | **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | -| **Earliest Date** | 2015w35 (2015-08-30) | +| **Update Frequency** | Inactive - No longer updated since 2020w15| +| **Earliest Date** | 2015w35 | - + ## Overview {: .no_toc} diff --git a/docs/api/twitter.md b/docs/api/twitter.md index 6c339af47..d1ef3fae4 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -15,7 +15,7 @@ nav_order: 2 | **Data Source** | [HealthTweets](http://www.healthtweets.org/) | | **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Resolution** | Daily and Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated | +| **Update Frequency** | Inactive - No longer updated since 2020w31 (2020-12-07)| | **Earliest Date** | 2011w48 (2011-11-27) | diff --git a/docs/api/wiki.md b/docs/api/wiki.md index e5084808d..743786ab5 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -13,14 +13,13 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `wiki` | | **Data Source** | [Wikimedia pageviews](https://dumps.wikimedia.org/other/pagecounts-raw/) for health-related Wikipedia articles | -| **Dataset Type** | Surveillance (Inactive) | | **Geographic Coverage** | Not applicable (article-based) | | **Temporal Resolution** | Hourly, Daily, and Weekly (Epiweek) | -| **Available Articles** | [54 health-related articles](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/articles.txt) | -| **Update Frequency** | Inactive - No longer updated | -| **License** | Open Access | +| **Available Articles** | [54 health-related articles](wiki_articles.html) | +| **Update Frequency** | Inactive - No longer updated since 2021w11| +| **Earliest Date** | 2007w50 (2007-12-09) | +| **License** | [CC BY-SA](https://creativecommons.org/licenses/by-sa/4.0/) | - ## Overview {: .no_toc} diff --git a/docs/api/wiki_articles.md b/docs/api/wiki_articles.md new file mode 100644 index 000000000..3e9895de4 --- /dev/null +++ b/docs/api/wiki_articles.md @@ -0,0 +1,77 @@ +--- +title: Wikipedia Articles +parent: Other Endpoints (COVID-19 and Other Diseases) +nav_order: 101 +--- + +# Wikipedia Articles +{: .no_toc} + +This page documents the valid Wikipedia articles accepted by the [Wikipedia Access](wiki.html) endpoint. + +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + +## Available Articles + +The following health-related Wikipedia articles are available: + +| Article Name | +|---| +| amantadine | +| antiviral_drugs | +| avian_influenza | +| canine_influenza | +| cat_flu | +| chills | +| common_cold | +| cough | +| equine_influenza | +| fatigue_(medical) | +| fever | +| flu_season | +| gastroenteritis | +| headache | +| hemagglutinin_(influenza) | +| human_flu | +| influenza | +| influenzalike_illness | +| influenzavirus_a | +| influenzavirus_c | +| influenza_a_virus | +| influenza_a_virus_subtype_h10n7 | +| influenza_a_virus_subtype_h1n1 | +| influenza_a_virus_subtype_h1n2 | +| influenza_a_virus_subtype_h2n2 | +| influenza_a_virus_subtype_h3n2 | +| influenza_a_virus_subtype_h3n8 | +| influenza_a_virus_subtype_h5n1 | +| influenza_a_virus_subtype_h7n2 | +| influenza_a_virus_subtype_h7n3 | +| influenza_a_virus_subtype_h7n7 | +| influenza_a_virus_subtype_h7n9 | +| influenza_a_virus_subtype_h9n2 | +| influenza_b_virus | +| influenza_pandemic | +| influenza_prevention | +| influenza_vaccine | +| malaise | +| myalgia | +| nasal_congestion | +| nausea | +| neuraminidase_inhibitor | +| orthomyxoviridae | +| oseltamivir | +| paracetamol | +| rhinorrhea | +| rimantadine | +| shivering | +| sore_throat | +| swine_influenza | +| viral_neuraminidase | +| viral_pneumonia | +| vomiting | +| zanamivir | From a1fb3c16a40049f5531667a9eb6682d049bf723e Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Mon, 1 Dec 2025 08:34:47 -0800 Subject: [PATCH 44/64] docs: update header for covidcast signals and include last update date for inactive sources. --- docs/api/covidcast-signals/chng.md | 14 +++++--- docs/api/covidcast-signals/covid-act-now.md | 14 +++++--- .../covid-trends-and-impact-survey.md | 14 +++++--- docs/api/covidcast-signals/doctor-visits.md | 14 +++++--- docs/api/covidcast-signals/dsew-cpr.md | 14 +++++--- docs/api/covidcast-signals/ght.md | 13 ++++--- docs/api/covidcast-signals/google-survey.md | 14 +++++--- docs/api/covidcast-signals/google-symptoms.md | 15 +++++--- docs/api/covidcast-signals/hhs.md | 14 +++++--- .../covidcast-signals/hospital-admissions.md | 15 +++++--- .../indicator-combination.md | 36 ++++++++++--------- docs/api/covidcast-signals/jhu-csse.md | 14 +++++--- docs/api/covidcast-signals/nchs-mortality.md | 15 +++++--- docs/api/covidcast-signals/nhsn.md | 16 +++++---- docs/api/covidcast-signals/nssp.md | 15 ++++---- docs/api/covidcast-signals/quidel.md | 19 ++++++---- docs/api/covidcast-signals/safegraph.md | 20 +++++------ docs/api/covidcast-signals/usa-facts.md | 14 +++++--- docs/api/covidcast-signals/youtube-survey.md | 15 +++++--- 19 files changed, 190 insertions(+), 115 deletions(-) diff --git a/docs/api/covidcast-signals/chng.md b/docs/api/covidcast-signals/chng.md index 51e435ec2..a75c0a940 100644 --- a/docs/api/covidcast-signals/chng.md +++ b/docs/api/covidcast-signals/chng.md @@ -8,11 +8,15 @@ nav_order: 2 # Change Healthcare {: .no_toc} -* **Source name:** `chng` -* **Earliest issue available:** November 4, 2020 -* **Geography type available:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `chng` | +| **Data Source** | Change Healthcare | +| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2024-02-19 | +| **Earliest Date** | 2020-02-01 | +| **License** | [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) | ## Overview {: .no_toc} diff --git a/docs/api/covidcast-signals/covid-act-now.md b/docs/api/covidcast-signals/covid-act-now.md index b0ae0738b..6ced07f50 100644 --- a/docs/api/covidcast-signals/covid-act-now.md +++ b/docs/api/covidcast-signals/covid-act-now.md @@ -8,11 +8,15 @@ nav_order: 2 # COVID Act Now (CAN) {: .no_toc} -* **Source name:** `covid-act-now` -* **Earliest issue available:** 2021-03-25 -* **Geography type available:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `covid-act-now` | +| **Data Source** | COVID Act Now | +| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2021-12-02 | +| **Earliest Date** | 2020-03-01 | +| **License** | [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) | The [COVID Act Now (CAN)](https://covidactnow.org/) data source provides COVID-19 testing statistics, such as positivity rates and total tests performed. The county-level positivity rates and test totals are pulled directly from CAN using [their API](https://covidactnow.org/data-api). diff --git a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md index 56a0763ce..77ea85f5a 100644 --- a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -9,11 +9,15 @@ permalink: api/covidcast-signals/fb-survey.html # COVID-19 Trends and Impact Survey (CTIS) {: .no_toc} -* **Source name:** `fb-survey` -* **Earliest issue available:** April 29, 2020 -* **Geography type available:** county, hrr, msa, state, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `fb-survey` | +| **Data Source** | [COVID-19 Trends and Impact Survey (CTIS)](../../symptom-survey/) | +| **Geographic Coverage** | National, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2022-06-25 | +| **Earliest Date** | Varies by indicator - 2020-2021 | +| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | ## Overview diff --git a/docs/api/covidcast-signals/doctor-visits.md b/docs/api/covidcast-signals/doctor-visits.md index bdad5a632..16f2829b0 100644 --- a/docs/api/covidcast-signals/doctor-visits.md +++ b/docs/api/covidcast-signals/doctor-visits.md @@ -8,11 +8,15 @@ nav_order: 1 # Doctor Visits {: .no_toc} -* **Source name:** `doctor-visits` -* **Earliest issue available:** April 29, 2020 -* **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `doctor-visits` | +| **Data Source** | Health system partners | +| **Geographic Coverage** | State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Daily | +| **Earliest Date** | 2020-02-01 | +| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | ## Overview diff --git a/docs/api/covidcast-signals/dsew-cpr.md b/docs/api/covidcast-signals/dsew-cpr.md index 05ab5bdd7..eae45ea30 100644 --- a/docs/api/covidcast-signals/dsew-cpr.md +++ b/docs/api/covidcast-signals/dsew-cpr.md @@ -8,11 +8,15 @@ nav_order: 2 # Data Strategy and Execution Workgroup Community Profile Report (CPR) {: .no_toc} -* **Source name:** `dsew-cpr` -* **Earliest issue available:** 2022-01-28 -* **Geography type available:** county, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [Public Domain US Government](https://www.usa.gov/government-works) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `dsew-cpr` | +| **Data Source** | [Community Profile Report (CPR)](https://healthdata.gov/Health/COVID-19-Community-Profile-Report/gqxm-d9w9) | +| **Geographic Coverage** | National, U.S. HHS Region, State, County, Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2023-02-22 | +| **Earliest Date** | Varies by indicator - 2020-2021 | +| **License** | [Public Domain US Government](https://www.usa.gov/government-works) | The Community Profile Report (CPR) is published by the Data Strategy and Execution Workgroup (DSEW) of the White House COVID-19 Team. For more information, see the [official description at healthdata.gov](https://healthdata.gov/Health/COVID-19-Community-Profile-Report/gqxm-d9w9) for "COVID-19 Community Profile Report". Each issue of the CPR is made available as an attachment on that page. You can view all attachments by scrolling to the bottom of the "About this dataset" panel and clicking "Show more". diff --git a/docs/api/covidcast-signals/ght.md b/docs/api/covidcast-signals/ght.md index 52181290c..2e52c2d82 100644 --- a/docs/api/covidcast-signals/ght.md +++ b/docs/api/covidcast-signals/ght.md @@ -8,10 +8,15 @@ nav_order: 2 # Google Health Trends {: .no_toc} -* **Source name:** `ght` -* **Earliest issue available:** April 29, 2020 -* **Geography type available:** dma, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `ght` | +| **Data Source** | Google Health Trends | +| **Geographic Coverage** | State, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA), Designated Marketing Area (DMA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2021-03-04 | +| **Earliest Date** | 2020-02-01 | +| **License** | [Google Terms of Service](https://policies.google.com/terms)| ## Overview diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md index 10a1f0bf4..a57bf0afd 100644 --- a/docs/api/covidcast-signals/google-survey.md +++ b/docs/api/covidcast-signals/google-survey.md @@ -8,11 +8,15 @@ nav_order: 2 # Google Symptom Surveys {: .no_toc} -* **Source name:** `google-survey` -* **Earliest issue available:** May 01, 2020 -* **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `google-survey` | +| **Data Source** | [Google-run symptom surveys](https://9to5google.com/2020/03/23/google-coronavirus-survey/)/Delphi | +| **Geographic Coverage** | National, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2020-05-14 | +| **Earliest Date** | 2020-04-11 | +| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | ## Overview diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index c37d84c6c..f6c1e09ad 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -8,11 +8,16 @@ nav_order: 2 # Google Symptoms {: .no_toc} -* **Source name:** `google-symptoms` -* **Earliest issue available:** Aug 20, 2017 -* **Geography type available:** county, MSA, HRR, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** To download or use the data, you must agree to the Google [Terms of Service](https://policies.google.com/terms) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `google-symptoms` | +| **Data Source** | Google | +| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Earliest Date** | 2020-02-13, with some variation depending on geographic area| +| **License** | [Google Terms of Service](https://policies.google.com/terms) | + + ## Overview {: .no_toc} diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index 287a7a124..c2cbb50b6 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -8,11 +8,15 @@ nav_order: 2 # Department of Health & Human Services Hospitalizations {: .no_toc} -* **Source name:** `hhs` -* **Earliest issue available:** November 16, 2020 -* **Geography type available:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [Public Domain US Government](https://www.usa.gov/government-works) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `hhs` | +| **Data Source** | U.S. Department of Health & Human Services | +| **Geographic Coverage** | National, U.S. HHS Region, State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - no longer updated since 2024-04-30 | +| **Earliest Date** | 2019-12-31 | +| **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. The data is made available diff --git a/docs/api/covidcast-signals/hospital-admissions.md b/docs/api/covidcast-signals/hospital-admissions.md index b1a0f116d..6d2b9c7db 100644 --- a/docs/api/covidcast-signals/hospital-admissions.md +++ b/docs/api/covidcast-signals/hospital-admissions.md @@ -8,11 +8,16 @@ nav_order: 1 # Hospital Admissions {: .no_toc} -* **Source name:** `hospital-admissions` -* **Earliest issue available:** June 21, 2020 -* **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +| Attribute | Details | +| :--- | :--- | +| **Data Source** | Health system partners | +| **Geographic Coverage** | National, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Daily | +| **Earliest Date** | 2020-02-01 | +| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | + + ## Overview {: .no_toc} diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index cfcaeb79f..9cae4dabb 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -8,23 +8,18 @@ nav_order: 2 # Indicator Combination {: .no_toc} -* **Source name:** `indicator-combination` - -This source provides signals which are combinations of the other sources, -calculated or composed by Delphi. It is not a primary data source. - -## Table of contents -{: .no_toc .text-delta} - -1. TOC -{:toc} - -## Statistical Combination Signals - -* **Earliest issue available:** May 20, 2020 -* **Geography type available:** county, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `indicator-combination` | +| **Data Source** | Delphi | +| **Geographic Coverage** | State, County, Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - no longer updated since 2021-03-16 | +| **Earliest Date** | 2020-04-06 | +| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | + +## Overview +{: .no_toc} These signals combine Delphi's indicators---*not* including cases and deaths, but including other signals expected to be related to the underlying rate of @@ -41,6 +36,13 @@ These signals were updated daily until March 17, 2021. | `nmf_day_doc_fbc_fbs_ght` | This signal uses a rank-1 approximation, from a nonnegative matrix factorization approach, to identify an underlying signal that best reconstructs the Doctor Visits (`smoothed_adj_cli`), Facebook Symptoms surveys (`smoothed_cli`), Facebook Symptoms in Community surveys (`smoothed_hh_cmnty_cli`), and Search Trends (`smoothed_search`) indicators. It does not include official reports (cases and deaths from the `jhu-csse` source). Higher values of the combined signal correspond to higher values of the other indicators, but the scale (units) of the combination is arbitrary. Note that the Search Trends source is not available at the county level, so county values of this signal do not use it. This signal is deprecated and is no longer updated as of March 17, 2021.
**Earliest date available:** 2020-04-15 | | `nmf_day_doc_fbs_ght` | This signal is calculated in the same way as `nmf_day_doc_fbc_fbs_ght`, but does *not* include the Symptoms in Community survey signal, which was not available at the time this signal was introduced. It also uses `smoothed_cli` from the `doctor-visits` source instead of `smoothed_adj_cli`. This signal is deprecated and is no longer updated as of May 27, 2020.
**Earliest date available:** 2020-04-06 | +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + + ### Estimation Let $$x_{rs}(t)$$ denote the value of sensor $$s$$ on day $$t$$ in region $$r$$ diff --git a/docs/api/covidcast-signals/jhu-csse.md b/docs/api/covidcast-signals/jhu-csse.md index 622d26397..c80dfc5cd 100644 --- a/docs/api/covidcast-signals/jhu-csse.md +++ b/docs/api/covidcast-signals/jhu-csse.md @@ -8,11 +8,15 @@ nav_order: 2 # JHU Cases and Deaths {: .no_toc} -* **Source name:** `jhu-csse` -* **Earliest issue available:** May 7, 2020 -* **Geography type available:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY](#source-and-licensing) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `jhu-csse` | +| **Data Source** | JHU CSSE | +| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2023-03-09 | +| **Earliest Date** | 2020-01-22, with some variation by geographic area | +| **License** | [CC BY](#source-and-licensing) | ## Overview diff --git a/docs/api/covidcast-signals/nchs-mortality.md b/docs/api/covidcast-signals/nchs-mortality.md index 7f7c4cdd9..d696b8644 100644 --- a/docs/api/covidcast-signals/nchs-mortality.md +++ b/docs/api/covidcast-signals/nchs-mortality.md @@ -8,11 +8,16 @@ nav_order: 1 # NCHS Mortality Data {: .no_toc} -* **Source name:** `nchs-mortality` -* **Earliest issue available:** Epiweek 50 2020 (6-12 December 2020) -* **Geography type available:** state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** week (see [date format docs](../covidcast_times.md)) -* **License:** [NCHS Data Use Agreement](https://www.cdc.gov/nchs/data_access/restrictions.htm) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `nchs-mortality` | +| **Data Source** | [National Center for Health Statistics +(NCHS)](https://www.cdc.gov/nchs/nvss/vsrr/COVID19/index.htm) | +| **Geographic Coverage** | State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Weekly (see [date format docs](../covidcast_times.md))| +| **Update Frequency** | Weekly | +| **Earliest Date** | 2020w05 with some variation by geography | +| **License** | [NCHS Data Use Agreement](https://www.cdc.gov/nchs/data_access/restrictions.htm) | This data source of national provisional death counts is based on death certificate data received and coded by the National Center for Health Statistics diff --git a/docs/api/covidcast-signals/nhsn.md b/docs/api/covidcast-signals/nhsn.md index c16e3ce13..d24078329 100644 --- a/docs/api/covidcast-signals/nhsn.md +++ b/docs/api/covidcast-signals/nhsn.md @@ -7,11 +7,15 @@ nav_order: 1 # National Healthcare Safety Network Respiratory Hospitalizations {: .no_toc} -* **Source name:** `nhsn` -* **Earliest issue available:** November 19, 2024 -* **Geography type available:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** week (see [date format docs](../covidcast_times.md)) -* **License:** [Public Domain US Government](https://www.usa.gov/government-works) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `nhsn` | +| **Data Source** | [The National Healthcare Safety Network (NHSN)](https://www.cdc.gov/nhsn/index.html) | +| **Geographic Coverage** | National, U.S. HHS Region, State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Weekly (Sunday to Saturday) (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Weekly | +| **Earliest Date** | 2020-08-08 | +| **License** | [Public Domain US Government](https://www.usa.gov/government-works) | ## Overview {: .no_toc} @@ -32,8 +36,6 @@ State and nation-level values are pulled directly from the source; HHS-level val ### Available Signals {: .no_toc} -* **Earliest date available:** August 8, 2020 -* **Time:** Week (Sunday to Saturday) * **Reporting Cutoffs:** * **Finalized Signals:** Data received by Friday/Saturday of the following week (~6-7 day lag). * **Preliminary (`_prelim`) Signals:** Data received by Wednesday of the following week (~4 day lag). diff --git a/docs/api/covidcast-signals/nssp.md b/docs/api/covidcast-signals/nssp.md index 80cb59e3e..41798735e 100644 --- a/docs/api/covidcast-signals/nssp.md +++ b/docs/api/covidcast-signals/nssp.md @@ -7,11 +7,15 @@ nav_order: 1 # National Syndromic Surveillance Program Emergency Department Visits {: .no_toc} -* **Source name:** `nssp` -* **Earliest issue available:** April 17, 2024 -* **Geography type available:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** week (see [date format docs](../covidcast_times.md)) -* **License:** [Public Domain US Government](https://www.usa.gov/government-works) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `nssp` | +| **Data Source** | [The National Syndromic Surveillance Program (NSSP)](https://www.cdc.gov/nssp/php/about/index.html) | +| **Geographic Coverage** | National, U.S. HHS Region, State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Weekly (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Weekly | +| **Earliest Date** | 2022-10-01 | +| **License** | [Public Domain US Government](https://www.usa.gov/government-works) | ## Overview {: .no_toc} @@ -25,7 +29,6 @@ As of May 2024, NSSP received data from 78% of US EDs. ### Available Signals {: .no_toc} -* **Earliest date available:** August 8, 2020 * **Raw Signals** (`pct_ed_visits_...`) represent the weekly percentage of ED visits for the specific pathogen. * **Smoothed Signals** (`smoothed_pct_ed_visits_...`) represent a **3-week moving average** of the raw signal. diff --git a/docs/api/covidcast-signals/quidel.md b/docs/api/covidcast-signals/quidel.md index 006d71b05..edc34c7d3 100644 --- a/docs/api/covidcast-signals/quidel.md +++ b/docs/api/covidcast-signals/quidel.md @@ -8,6 +8,16 @@ nav_order: 1 # Quidel {: .no_toc} +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `quidel` | +| **Data Source** | QuidelOrtho Corp. | +| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Daily | +| **Earliest Date** | 2020-05-26 | +| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | + ## Table of Contents {: .no_toc .text-delta} @@ -15,16 +25,13 @@ nav_order: 1 {:toc} ## Accessibility: Delphi-internal only +{: .no_toc} ## Quidel COVID-19 Tests - -* **Source name:** `quidel` -* **Earliest issue available:** July 29, 2020 -* **Geography type available:** county, hrr, msa, state, HHS, nation (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) +{: .no_toc} ### Overview +{: .no_toc} Data source based on COVID-19 Antigen tests, provided to us by Quidel, Inc. When a patient (whether at a doctor’s office, clinic, or hospital) has COVID-like diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index 5b8e2f909..7c6be35f3 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -7,10 +7,16 @@ nav_order: 2 # SafeGraph {: .no_toc} -* **Source name:** `safegraph` -* **Geography type available:** county, MSA, HRR, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution) + +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `safegraph` | +| **Data Source** | SafeGraph | +| **Geographic Coverage** | State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md))| +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2021-04-19 | +| **Earliest Date** | 2019-01-01 | +| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | This data source uses data reported by [SafeGraph](https://www.safegraph.com/) using anonymized location data from mobile phones. From June 2020-July 2022, @@ -25,12 +31,6 @@ surface signals from two such datasets. ## SafeGraph Social Distancing Metrics -* **Earliest issue available:** June 20, 2020 -* **Number of data revisions since June 23, 2020:** 1 -* **Date of last change:** November 3, 2020 - -**This dataset is no longer updated after April 19th, 2021.** - Data source based on the [Social Distancing Metrics](https://docs.safegraph.com/docs/social-distancing-metrics) data product. SafeGraph provided this data for individual census block groups, using differential privacy to protect individual people's data privacy. diff --git a/docs/api/covidcast-signals/usa-facts.md b/docs/api/covidcast-signals/usa-facts.md index fb55a4305..4767672fe 100644 --- a/docs/api/covidcast-signals/usa-facts.md +++ b/docs/api/covidcast-signals/usa-facts.md @@ -8,11 +8,15 @@ nav_order: 2 # USAFacts Cases and Deaths {: .no_toc} -* **Source name:** `usa-facts` -* **Earliest issue available:** June 24, 2020 -* **Geography type available:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY](#source-and-licensing) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `usa-facts` | +| **Data Source** | [USAFacts](https://usafacts.org/) | +| **Geographic Coverage** | National, U.S. HHS Region, State/ADM 1, County/ADM 2, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2023-01-02 | +| **Earliest Date** | 2020-01-25 | +| **License** | [CC BY](#source-and-licensing) | This data source of confirmed COVID-19 cases and deaths is based on reports made available by [USAFacts](https://usafacts.org/). diff --git a/docs/api/covidcast-signals/youtube-survey.md b/docs/api/covidcast-signals/youtube-survey.md index e23bf67f7..2364bbfbc 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -10,11 +10,16 @@ nav_order: 2 # Youtube Survey {: .no_toc} -* **Source name:** `youtube-survey` -* **Earliest issue available:** May 01, 2020 -* **Geography type available:** state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) -* **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `youtube-survey` | +| **Data Source** | Google/Delphi | +| **Geographic Coverage** | State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated | +| **License** | [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) | + + ## Overview From b9c6c6222857af324e23f0147fff7f409d1afc41 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Mon, 1 Dec 2025 08:46:36 -0800 Subject: [PATCH 45/64] docs: add examples to use callouts and tabs --- docs/tabs_demo.md | 150 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 150 insertions(+) create mode 100644 docs/tabs_demo.md diff --git a/docs/tabs_demo.md b/docs/tabs_demo.md new file mode 100644 index 000000000..33adcb6b7 --- /dev/null +++ b/docs/tabs_demo.md @@ -0,0 +1,150 @@ +--- +title: Documentation Features Tutorial +nav_exclude: true +--- + +# Documentation Features Tutorial +{: .no_toc} + + +## Table of Contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + +## Callouts + +You can use blockquotes with specific classes to create callouts for notes, warnings, and other important information. + +### Syntax + +Use the following syntax: + +```markdown +> **Label:** Your text here. +{: .class-name } +``` + +### Available Classes + +#### Note +```markdown +> **Note:** This is a note. +{: .note } +``` +> **Note:** This is a note. +{: .note } + +#### Important +```markdown +> **Important:** This is important information. +{: .important } +``` +> **Important:** This is important information. +{: .important } + +#### Warning +```markdown +> **Warning:** This is a warning. +{: .warning } +``` +> **Warning:** This is a warning. +{: .warning } + +#### Tip +```markdown +> **Tip:** This is a helpful tip. +{: .tip } +``` +> **Tip:** This is a helpful tip. +{: .tip } + +#### Caution +```markdown +> **Caution:** Proceed with caution. +{: .caution } +``` +> **Caution:** Proceed with caution. +{: .caution } + +## Code Tabs + +### Structure + +The structure consists of a container `div` with class `code-tabs`, a header `div` with class `tab-header` containing buttons, and multiple content `div`s with class `tab-content`. + +**Key Requirements:** +1. **Container:** `
` +2. **Header:** `
` containing ` + + +
+ +
+ +```python +import pandas as pd +``` + +
+ +
+ +```r +library(covidcast) +``` +
+ +
+ +```bash +curl ... +``` +
+
+ +### Source Code for Example + +```html +
+
+ + + +
+ +
+ + ```python + import pandas as pd + ``` + +
+ +
+ + ```r + library(covidcast) + ``` + +
+ +
+ + ```bash + curl ... + ``` + +
+
+``` From 6173852ce6e7ed23fbd9fd33c3d19c6ecaac2bbc Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Mon, 1 Dec 2025 12:20:25 -0800 Subject: [PATCH 46/64] docs: update API clients sections to direct to client_libraries and enhance reference to legacy client --- docs/api/01meta.md | 4 +- docs/api/cdc.md | 4 +- docs/api/client_libraries.md | 465 ++++++++++++++++++++--- docs/api/covidcast_clients.md | 6 + docs/api/delphi.md | 4 +- docs/api/dengue_digital_surveillance.md | 4 +- docs/api/dengue_nowcast.md | 4 +- docs/api/digital_surveillance_sensors.md | 4 +- docs/api/ecdc_ili.md | 4 +- docs/api/flusurv.md | 4 +- docs/api/fluview.md | 4 +- docs/api/fluview_clinical.md | 4 +- docs/api/gft.md | 4 +- docs/api/ght.md | 4 +- docs/api/ili_nearby_nowcast.md | 4 +- docs/api/kcdc_ili.md | 4 +- docs/api/nidss_dengue.md | 4 +- docs/api/nidss_flu.md | 4 +- docs/api/norostat.md | 4 +- docs/api/norostat_meta.md | 4 +- docs/api/paho_dengue.md | 4 +- docs/api/quidel.md | 4 +- docs/api/twitter.md | 4 +- docs/api/wiki.md | 3 +- 24 files changed, 459 insertions(+), 99 deletions(-) diff --git a/docs/api/01meta.md b/docs/api/01meta.md index 994a77fcf..f918f24fe 100644 --- a/docs/api/01meta.md +++ b/docs/api/01meta.md @@ -149,7 +149,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -191,7 +191,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/cdc.md b/docs/api/cdc.md index e080f450e..5f570bec6 100644 --- a/docs/api/cdc.md +++ b/docs/api/cdc.md @@ -144,7 +144,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -186,7 +186,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/client_libraries.md b/docs/api/client_libraries.md index dea8fad24..8b1ff5760 100644 --- a/docs/api/client_libraries.md +++ b/docs/api/client_libraries.md @@ -3,41 +3,111 @@ title: API Clients nav_order: 6 --- -# Epidata API Clients +# Getting Started with R and Python +{: .no_toc} -To access Delphi Epidata programmatically, we recommend our client libraries: +The [`epidatr`](https://cmu-delphi.github.io/epidatr/) (R) [`epidatpy`](https://cmu-delphi.github.io/epidatpy/) (Python) packages provide access to all the endpoints of the Delphi Epidata API, and can be used to make requests for specific signals on specific dates and in select geographic regions. -- R: [epidatr](https://cmu-delphi.github.io/epidatr/), -- Python: [epidatpy](https://cmu-delphi.github.io/epidatpy/) (recommended) and [delphi-epidata](https://pypi.org/project/delphi-epidata/), -- Javascript: [delphi-epidata](https://github.com/cmu-delphi/delphi-epidata/blob/master/src/client/delphi_epidata.js). +## Table of Contents +{: .no_toc .text-delta} -For anyone looking for COVIDCast data, please visit our [COVIDCast API Client Libraries](covidcast_clients.md). +1. TOC +{:toc} -The following samples show how to import the library and fetch Delphi's -COVID-19 Surveillance Streams from Facebook Survey CLI for county 06001 and days -`20200401` and `20200405-20200414` (11 days total). +## Setup + +### Installation + +You can install these packages like this:
- - - + +
-
+
+ +You can install the stable version of `epidatr` from CRAN: + +```r +install.packages("epidatr") +# Or use pak/renv +pak::pkg_install("epidatr") +``` +If you want the development version, install from GitHub: + +```r +remotes::install_github("cmu-delphi/epidatr", ref = "dev") +``` + +
+
The `epidatpy` package will soon be [available on PyPI as `epidatpy`](https://pypi.org/project/epidatpy/). Meanwhile, it can be [installed from GitHub](https://github.com/cmu-delphi/epidatpy/) with -`pip install "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy"`. + +```Python +pip install "git+https://github.com/cmu-delphi/epidatpy.git#egg=epidatpy" +``` + +
+
+ +### API Keys + +The Delphi API requires a (free) API key for full functionality. While most endpoints are available without one, there are [limits on API usage for anonymous users](/api_keys.md), including a rate limit. + +To generate your key, [register for a pseudo-anonymous account](https://api.delphi.cmu.edu/epidata/admin/registration_form). + + * **R:** See the `save_api_key()` function documentation for details on how to set up `epidatr` to use your API key. + * **Python:** The `epidatpy` client will automatically look for this key in the environment variable `DELPHI_EPIDATA_KEY`. We recommend storing your key in a `.env` file, using `python-dotenv` to load it into your environment, and adding `.env` to your `.gitignore` file. + +> **Note:** Private endpoints (i.e. those prefixed with `pvt_`) require a separate key that needs to be passed as an argument. These endpoints require specific data use agreements to access. +{: .note } + +## Basic Usage + +Fetching data from the Delphi Epidata API is simple. Suppose we are interested in the [`covidcast` endpoint](/covidcast.md), which provides access to a [wide range of data](/covidcast_signals.md) on COVID-19. Reviewing the endpoint documentation, we see that we [need to specify](/covidcast_api_queries.md) a data source name, a signal name, a geographic level, a time resolution, and the location and times of interest. + +The `pub_covidcast()` function lets us access the `covidcast` endpoint: + +
+
+ + +
+ +
+ +```r +library(epidatr) +library(dplyr) + +# Obtain the most up-to-date version of the smoothed covid-like illness (CLI) +# signal from the COVID-19 Trends and Impact survey for the US +epidata <- pub_covidcast( + source = "fb-survey", + signals = "smoothed_cli", + geo_type = "nation", + time_type = "day", + geo_values = "us", + time_values = epirange(20210105, 20210410) +) +head(epidata) +``` + +
+
```python -# Configure API key, if needed. -# https://github.com/cmu-delphi/epidatpy/blob/dev/docs/index.rst#api-keys +from epidatpy import CovidcastEpidata, EpiDataContext, EpiRange -from epidatpy import EpiDataContext, EpiRange +# Initialize client (caching enabled for 7 days) +epidata = EpiDataContext(use_cache=True, cache_max_age_days=7) -# Create the client object. -epidata = EpiDataContext() +# Obtain the most up-to-date version of the confirmed cumulative cases +# from JHU CSSE for the US apicall = epidata.pub_covidcast( data_source="jhu-csse", signals="confirmed_cumulative_num", @@ -46,54 +116,342 @@ apicall = epidata.pub_covidcast( geo_values="us", time_values=EpiRange(20210405, 20210410), ) -print(apicall.df()) +print(apicall.df().head()) ``` +
+
-
+`pub_covidcast()` returns a `tibble` in R and an `EpiDataCall` (convertible to a pandas DataFrame via `.df()`) in Python. Each row represents one observation in the specified location on one day. The location abbreviation is given in the `geo_value` column, the date in the `time_value` column. Here `value` is the requested signal—in this case, the smoothed estimate of the percentage of people with COVID-like illness or case counts—and `stderr` is its standard error. + +The Epidata API makes signals available at different geographic levels, depending on the endpoint. To request signals for all states instead of the entire US, we use the `geo_type` argument paired with `*` for the `geo_values` argument. (Only some endpoints allow for the use of `*` to access data at all locations. Check the help for a given endpoint to see if it supports `*`.) + +
+
+ + +
-Install [`epidatr` from CRAN](https://cran.r-project.org/package=epidatr) -with `install.packages("epidatr")`. +
```r -# Configure API key interactively, if needed. See -# https://cmu-delphi.github.io/epidatr/articles/epidatr.html#api-keys for details. -#save_api_key() -library(epidatr) -data <- pub_covidcast('fb-survey', 'smoothed_cli', 'county', 'day', geo_values = '06001', - time_values = c(20200401, 20200405:20200414)) -print(data) +# Obtain data for all states +pub_covidcast( + source = "fb-survey", + signals = "smoothed_cli", + geo_type = "state", + time_type = "day", + geo_values = "*", + time_values = epirange(20210105, 20210410) +) ``` +
+
-
+```python +# Obtain data for all states +epidata.pub_covidcast( + data_source="fb-survey", + signals="smoothed_cli", + geo_type="state", + time_type="day", + geo_values="*", + time_values=EpiRange(20210405, 20210410), +).df() +``` -The minimalist JavaScript client does not currently support API keys. -If you need API key support in JavaScript, contact delphi-support+privacy@andrew.cmu.edu. +
+
-```html - - +Alternatively, we can fetch the full time series for a subset of states by listing out the desired locations in the `geo_value` argument and using `*` in the `time_values` argument: + +
+
+ + +
+ +
+ +```r +# Obtain data for PA, CA, and FL +pub_covidcast( + source = "fb-survey", + signals = "smoothed_cli", + geo_type = "state", + time_type = "day", + geo_values = c("pa", "ca", "fl"), + time_values = "*" +) ``` + +
+
+ +```python +# Obtain data for PA, CA, and FL +epidata.pub_covidcast( + data_source="fb-survey", + signals="smoothed_cli", + geo_type="state", + time_type="day", + geo_values="pa,ca,fl", + time_values="*", +).df() +``` +
-### Legacy Clients +## Getting versioned data + +The Epidata API stores a historical record of all data, including corrections and updates, which is particularly useful for accurately backtesting forecasting models. To retrieve versioned data, we can use the `as_of` argument, which fetches the data as it was known on a specific date. + +
+
+ + +
+ +
+ +```r +# Obtain the signal as it was on 2021-06-01 +pub_covidcast( + source = "fb-survey", + signals = "smoothed_cli", + geo_type = "state", + time_type = "day", + geo_values = "pa", + time_values = epirange(20210105, 20210410), + as_of = "2021-06-01" +) +``` + +
+
+ +```python +# Obtain the signal as it was on 2021-06-01 +epidata.pub_covidcast( + data_source="fb-survey", + signals="smoothed_cli", + geo_type="state", + time_type="day", + geo_values="pa", + time_values=EpiRange(20210405, 20210410), + as_of="2021-06-01", +).df() +``` + +
+
+ +We can also request all versions of the data issued within a specific time period using the `issues` argument. + +
+
+ + +
+ +
+ +```r +# See how the estimate for a SINGLE day (March 1, 2021) evolved +# by fetching all issues reported between March and April 2021. +pub_covidcast( + source = "fb-survey", + signals = "smoothed_cli", + geo_type = "state", + time_type = "day", + geo_values = "pa", + time_values = "2021-03-01", + issues = epirange("2021-03-01", "2021-04-30") +) +``` + +
+
+ +```python +# See how the estimate for a SINGLE day (March 1, 2021) evolved +# by fetching all issues reported between March and April 2021. +epidata.pub_covidcast( + data_source="fb-survey", + signals="smoothed_cli", + geo_type="state", + time_type="day", + geo_values="pa", + time_values="2021-03-01", + issues=EpiRange("2021-03-01", "2021-04-30"), +).df() +``` + +
+
+ +Finally, we can use the `lag` argument to request only data that was reported a certain number of days after the event. + +
+
+ + +
+ +
+ +```r +# Fetch survey data for January 2021, but ONLY include data +# that was issued exactly 2 days after it was collected. +pub_covidcast( + source = "fb-survey", + signals = "smoothed_cli", + geo_type = "state", + time_type = "day", + geo_values = "pa", + time_values = epirange(20210101, 20210131), + lag = 2 +) +``` + +
+
+ +```python +# Fetch survey data for January 2021, but ONLY include data +# that was issued exactly 2 days after it was collected. +epidata.pub_covidcast( + data_source="fb-survey", + signals="smoothed_cli", + geo_type="state", + time_type="day", + geo_values="pa", + time_values=EpiRange(20210101, 20210131), + lag=2, +).df() +``` + +
+
+ +See `vignette("versioned-data")` for details and more ways to specify versioned data. + +## Plotting + +Because the output data is in a standard `tibble` (R) or `DataFrame` (Python) format, we can easily plot it using standard libraries like `ggplot2` or `matplotlib`. + +
+
+ + +
+ +
+ +```r +library(ggplot2) +ggplot(epidata, aes(x = time_value, y = value)) + + geom_line() + + labs( + title = "Smoothed CLI from Facebook Survey", + subtitle = "PA, 2021", + x = "Date", + y = "CLI" + ) +``` + +
+
+ +```python +import matplotlib.pyplot as plt + +# Fetch data for PA, CA, FL +apicall = epidata.pub_covidcast( + data_source="fb-survey", + signals="smoothed_cli", + geo_type="state", + geo_values="pa,ca,fl", + time_type="day", + time_values=EpiRange(20210405, 20210410), +) + +# Plot +fig, ax = plt.subplots(figsize=(6, 5)) +( + apicall.df() + .pivot_table(values="value", index="time_value", columns="geo_value") + .plot(xlabel="Date", ylabel="CLI", ax=ax, linewidth=1.5) +) +plt.title("Smoothed CLI from Facebook Survey") +plt.show() +``` + +
+
+ +## Finding locations of interest + +Most data is only available for the US. Select endpoints report other countries at the national and/or regional levels. Endpoint descriptions explicitly state when they cover non-US locations. + +For endpoints that report US data, consult the geographic coding documentation for [COVID-19](/covidcast_geography.md) and for [other diseases](/geographic_codes.md) to see available geographic levels. + +### International data + +International data is available via + + * `pub_dengue_nowcast` (North and South America) + * `pub_ecdc_ili` (Europe) + * `pub_kcdc_ili` (Korea) + * `pub_nidss_dengue` (Taiwan) + * `pub_nidss_flu` (Taiwan) + * `pub_paho_dengue` (North and South America) + * `pvt_dengue_sensors` (North and South America) + +## Finding data sources and signals of interest + +Above we used data from [Delphi’s symptom surveys](https://delphi.cmu.edu/covid19/ctis/), but the Epidata API includes numerous data streams: medical claims data, cases and deaths, mobility, and many others. This can make it a challenge to find the data stream that you are most interested in. + +The Epidata documentation lists all the data sources and signals available through the API for [COVID-19](/covidcast_signals.md) and for [other diseases](README.md#source-specific-parameters). + +You can also use the client libraries to discover endpoints interactively: + +
+
+ + +
+ +
+ +```r +# Get a table of endpoint functions +avail_endpoints() +``` + +
+
+ +```python +# List sources available in the pub_covidcast endpoint +covidcast = CovidcastEpidata(use_cache=True) +print(covidcast.source_names()) + +# List signals available for a specific source (e.g., jhu-csse) +print(covidcast.signal_names("jhu-csse")) +``` + +
+
+ +## Legacy Clients + +Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js), +but its use is discouraged. + +The following samples show how to import the library and fetch Delphi’s COVID-19 Surveillance Streams from Facebook Survey CLI for county `06001` and days `20200401` and `20200405-20200414` (11 days total).
@@ -118,9 +476,6 @@ print(res['result'], res['message'], len(res['epidata']))
-The old Delphi Epidata R client is available -[here](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), -but its use is discouraged. ```R # Configure API key, if needed. diff --git a/docs/api/covidcast_clients.md b/docs/api/covidcast_clients.md index d4fe77699..f852bfafd 100644 --- a/docs/api/covidcast_clients.md +++ b/docs/api/covidcast_clients.md @@ -2,8 +2,14 @@ title: API Clients parent: Main Endpoint (COVIDcast) nav_order: 1 +nav_exclude: true +redirect_to: client_libraries.html --- + + +[Redirecting to Client Libraries...](client_libraries.html) + # Main Endpoint API Clients To access COVIDcast data, we recommend using the following client libraries: diff --git a/docs/api/delphi.md b/docs/api/delphi.md index a514e4bee..168218005 100644 --- a/docs/api/delphi.md +++ b/docs/api/delphi.md @@ -203,7 +203,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -244,7 +244,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/dengue_digital_surveillance.md b/docs/api/dengue_digital_surveillance.md index 4d42a3d20..ff9b664ec 100644 --- a/docs/api/dengue_digital_surveillance.md +++ b/docs/api/dengue_digital_surveillance.md @@ -131,7 +131,7 @@ print(res) ### Legacy Clients -We recommend using our client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using our client libraries: [epidatr](https://cmu-delphi.github.io/epidatr/) for R and [epidatpy](https://cmu-delphi.github.io/epidatpy/) for Python. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -171,7 +171,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/dengue_nowcast.md b/docs/api/dengue_nowcast.md index ad9a71453..f8a25f83b 100644 --- a/docs/api/dengue_nowcast.md +++ b/docs/api/dengue_nowcast.md @@ -127,7 +127,7 @@ print(res) ### Legacy Clients -For modern clients, we recommend using [R](https://cmu-delphi.github.io/epidatr/) and [Python](https://cmu-delphi.github.io/epidatpy/). The following clients are considered legacy: [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js), [Python](https://pypi.org/project/delphi-epidata/), and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -170,7 +170,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index 647002565..698468cea 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -145,7 +145,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -188,7 +188,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index 49fc47431..c8e3d0f91 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -147,7 +147,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -190,7 +190,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index 03c533224..e7e69e84a 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -207,7 +207,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -249,7 +249,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/fluview.md b/docs/api/fluview.md index ef10a0e5a..022824177 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -185,7 +185,7 @@ The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-e ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -226,7 +226,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index aba3d7852..61c6556e5 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -152,7 +152,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -194,7 +194,7 @@ print(length(res$epidata))
- The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/gft.md b/docs/api/gft.md index 149277fae..84439c795 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -125,7 +125,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -167,7 +167,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/ght.md b/docs/api/ght.md index 29a2ee528..bc688c7eb 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -133,7 +133,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -175,7 +175,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index 902008bf5..669600d6e 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -133,7 +133,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -175,7 +175,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index e1d1a0254..0f1d0b1f5 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -145,7 +145,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -187,7 +187,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 3c0daabff..8b6fad444 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -126,7 +126,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -172,7 +172,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index ef97e8003..19b7539a3 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -146,7 +146,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -192,7 +192,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/norostat.md b/docs/api/norostat.md index ce6c37df8..6afaacb55 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.md @@ -126,7 +126,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -168,7 +168,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/norostat_meta.md b/docs/api/norostat_meta.md index 64dde10ac..f32e11529 100644 --- a/docs/api/norostat_meta.md +++ b/docs/api/norostat_meta.md @@ -136,7 +136,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -178,7 +178,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index 552a1ba16..f564d3fe2 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -141,7 +141,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -178,7 +178,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/quidel.md b/docs/api/quidel.md index fc4de0b21..640db5439 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -128,7 +128,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -170,7 +170,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/twitter.md b/docs/api/twitter.md index d1ef3fae4..1044d3266 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -145,7 +145,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -187,7 +187,7 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). + ```html diff --git a/docs/api/wiki.md b/docs/api/wiki.md index 743786ab5..b44215fcc 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -168,7 +168,7 @@ print(res) ### Legacy Clients -We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/) and [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R). +We recommend using the modern client libraries mentioned above. Legacy clients are also available for [Python](https://pypi.org/project/delphi-epidata/), [R](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.R), and [JavaScript](https://github.com/cmu-delphi/delphi-epidata/blob/dev/src/client/delphi_epidata.js).
@@ -210,7 +210,6 @@ print(length(res$epidata))
-The JavaScript client is available [here](https://github.com/cmu-delphi/delphi-epidata/blob/main/src/client/delphi_epidata.js). ```html From c6a6ca2a644ba377d2834408522e903454a565e5 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Mon, 1 Dec 2025 20:56:00 -0800 Subject: [PATCH 47/64] docs: data source mode for NCHS --- docs/api/covidcast-signals/nchs-mortality.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/api/covidcast-signals/nchs-mortality.md b/docs/api/covidcast-signals/nchs-mortality.md index d696b8644..33f85ab53 100644 --- a/docs/api/covidcast-signals/nchs-mortality.md +++ b/docs/api/covidcast-signals/nchs-mortality.md @@ -11,8 +11,7 @@ nav_order: 1 | Attribute | Details | | :--- | :--- | | **Source Name** | `nchs-mortality` | -| **Data Source** | [National Center for Health Statistics -(NCHS)](https://www.cdc.gov/nchs/nvss/vsrr/COVID19/index.htm) | +| **Data Source** | [National Center for Health Statistics (NCHS)](https://www.cdc.gov/nchs/nvss/vsrr/COVID19/index.htm) | | **Geographic Coverage** | State (see [geography coding docs](../covidcast_geography.md)) | | **Temporal Resolution** | Weekly (see [date format docs](../covidcast_times.md))| | **Update Frequency** | Weekly | From 0eae530c4230593d5f6393e6332ac61e7dd5ad92 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 2 Dec 2025 12:12:50 -0800 Subject: [PATCH 48/64] docs: update header formatting for Quidel and Safegraph --- docs/_includes/head_custom.html | 12 +++++--- docs/api/covidcast-signals/quidel.md | 37 +++++++++++++------------ docs/api/covidcast-signals/safegraph.md | 10 +++---- 3 files changed, 32 insertions(+), 27 deletions(-) diff --git a/docs/_includes/head_custom.html b/docs/_includes/head_custom.html index d114d9d62..3bd88c990 100644 --- a/docs/_includes/head_custom.html +++ b/docs/_includes/head_custom.html @@ -1,5 +1,9 @@ - - - + - + \ No newline at end of file diff --git a/docs/api/covidcast-signals/quidel.md b/docs/api/covidcast-signals/quidel.md index edc34c7d3..44c155652 100644 --- a/docs/api/covidcast-signals/quidel.md +++ b/docs/api/covidcast-signals/quidel.md @@ -8,16 +8,6 @@ nav_order: 1 # Quidel {: .no_toc} -| Attribute | Details | -| :--- | :--- | -| **Source Name** | `quidel` | -| **Data Source** | QuidelOrtho Corp. | -| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Daily | -| **Earliest Date** | 2020-05-26 | -| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | - ## Table of Contents {: .no_toc .text-delta} @@ -30,6 +20,16 @@ nav_order: 1 ## Quidel COVID-19 Tests {: .no_toc} +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `quidel` | +| **Data Source** | QuidelOrtho Corp. | +| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Daily | +| **Earliest Date** | 2020-05-26 | +| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | + ### Overview {: .no_toc} @@ -170,13 +170,16 @@ that day will not include it. These signals are inactive. They were updated until May 19, 2020. -* **Source name:** `quidel` -* **Earliest issue available:** April 29, 2020 -* **Last issued:** May 19, 2020 -* **Number of data revisions since May 19, 2020:** 0 -* **Date of last change:** Never -* **Geography type available:** msa, state (see [geography coding docs](../covidcast_geography.md)) -* **Time type available:** day (see [date format docs](../covidcast_times.md)) +| Attribute | Details | +| :--- | :--- | +| **Source Name** | `quidel` | +| **Data Source** | QuidelOrtho Corp. | +| **Geographic Coverage** | State, Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | +| **Update Frequency** | Inactive - No longer updated since 2020-05-01 | +| **Earliest Date** | 2020-01-31 | +| **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | + ### Overview diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index 7c6be35f3..b0dc171ad 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -14,7 +14,7 @@ nav_order: 2 | **Data Source** | SafeGraph | | **Geographic Coverage** | State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md))| | **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2021-04-19 | +| **Update Frequency** | Inactive | | **Earliest Date** | 2019-01-01 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | @@ -31,6 +31,8 @@ surface signals from two such datasets. ## SafeGraph Social Distancing Metrics + + Data source based on the [Social Distancing Metrics](https://docs.safegraph.com/docs/social-distancing-metrics) data product. SafeGraph provided this data for individual census block groups, using differential privacy to protect individual people's data privacy. @@ -76,11 +78,7 @@ additional day for SafeGraph's data to be ingested into the COVIDcast API. ## SafeGraph Weekly Patterns -* **Earliest issue available:** November 30, 2020 -* **Number of data revisions since June 23, 2020:** 0 -* **Date of last change:** never - -**This dataset is no longer updated after July 15th, 2022.** + Data source based on [Weekly Patterns](https://docs.safegraph.com/docs/weekly-patterns) dataset. SafeGraph From 5a45d6ffbe19d3e1fba0c94a26b29a38ca849d11 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 9 Dec 2025 12:09:35 -0800 Subject: [PATCH 49/64] docs: fix headers to align with epiportal categories in covidcast --- docs/api/covidcast-signals/chng.md | 8 ++++---- docs/api/covidcast-signals/covid-act-now.md | 8 ++++---- .../covid-trends-and-impact-survey.md | 8 ++++---- docs/api/covidcast-signals/doctor-visits.md | 8 ++++---- docs/api/covidcast-signals/dsew-cpr.md | 8 ++++---- docs/api/covidcast-signals/ght.md | 8 ++++---- docs/api/covidcast-signals/google-survey.md | 8 ++++---- docs/api/covidcast-signals/google-symptoms.md | 8 ++++---- docs/api/covidcast-signals/hhs.md | 8 ++++---- .../api/covidcast-signals/hospital-admissions.md | 8 ++++---- .../covidcast-signals/indicator-combination.md | 8 ++++---- docs/api/covidcast-signals/jhu-csse.md | 8 ++++---- docs/api/covidcast-signals/nchs-mortality.md | 8 ++++---- docs/api/covidcast-signals/nhsn.md | 8 ++++---- docs/api/covidcast-signals/nssp.md | 8 ++++---- docs/api/covidcast-signals/quidel.md | 16 ++++++++-------- docs/api/covidcast-signals/safegraph.md | 8 ++++---- docs/api/covidcast-signals/usa-facts.md | 8 ++++---- docs/api/covidcast-signals/youtube-survey.md | 8 ++++---- 19 files changed, 80 insertions(+), 80 deletions(-) diff --git a/docs/api/covidcast-signals/chng.md b/docs/api/covidcast-signals/chng.md index a75c0a940..731847d71 100644 --- a/docs/api/covidcast-signals/chng.md +++ b/docs/api/covidcast-signals/chng.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `chng` | | **Data Source** | Change Healthcare | -| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2024-02-19 | -| **Earliest Date** | 2020-02-01 | +| **Geographic Levels** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated since 2024-02-19 | +| **Temporal Scope Start** | 2020-02-01 | | **License** | [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) | ## Overview diff --git a/docs/api/covidcast-signals/covid-act-now.md b/docs/api/covidcast-signals/covid-act-now.md index 6ced07f50..bc82b9425 100644 --- a/docs/api/covidcast-signals/covid-act-now.md +++ b/docs/api/covidcast-signals/covid-act-now.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `covid-act-now` | | **Data Source** | COVID Act Now | -| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2021-12-02 | -| **Earliest Date** | 2020-03-01 | +| **Geographic Levels** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated since 2021-12-02 | +| **Temporal Scope Start** | 2020-03-01 | | **License** | [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) | The [COVID Act Now (CAN)](https://covidactnow.org/) data source provides COVID-19 testing statistics, such as positivity rates and total tests performed. diff --git a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md index 77ea85f5a..5bbddcb0d 100644 --- a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -13,10 +13,10 @@ permalink: api/covidcast-signals/fb-survey.html | :--- | :--- | | **Source Name** | `fb-survey` | | **Data Source** | [COVID-19 Trends and Impact Survey (CTIS)](../../symptom-survey/) | -| **Geographic Coverage** | National, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2022-06-25 | -| **Earliest Date** | Varies by indicator - 2020-2021 | +| **Geographic Levels** | National, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated since 2022-06-25 | +| **Temporal Scope Start** | Varies by indicator - 2020-2021 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | ## Overview diff --git a/docs/api/covidcast-signals/doctor-visits.md b/docs/api/covidcast-signals/doctor-visits.md index 16f2829b0..9340a501d 100644 --- a/docs/api/covidcast-signals/doctor-visits.md +++ b/docs/api/covidcast-signals/doctor-visits.md @@ -12,10 +12,10 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `doctor-visits` | | **Data Source** | Health system partners | -| **Geographic Coverage** | State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Daily | -| **Earliest Date** | 2020-02-01 | +| **Geographic Levels** | State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Daily | +| **Temporal Scope Start** | 2020-02-01 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | diff --git a/docs/api/covidcast-signals/dsew-cpr.md b/docs/api/covidcast-signals/dsew-cpr.md index eae45ea30..46bc3104d 100644 --- a/docs/api/covidcast-signals/dsew-cpr.md +++ b/docs/api/covidcast-signals/dsew-cpr.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `dsew-cpr` | | **Data Source** | [Community Profile Report (CPR)](https://healthdata.gov/Health/COVID-19-Community-Profile-Report/gqxm-d9w9) | -| **Geographic Coverage** | National, U.S. HHS Region, State, County, Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2023-02-22 | -| **Earliest Date** | Varies by indicator - 2020-2021 | +| **Geographic Levels** | National, U.S. HHS Region, State, County, Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated since 2023-02-22 | +| **Temporal Scope Start** | Varies by indicator - 2020-2021 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | The Community Profile Report (CPR) is published by the Data Strategy and Execution Workgroup (DSEW) of the White House COVID-19 Team. For more information, see the [official description at healthdata.gov](https://healthdata.gov/Health/COVID-19-Community-Profile-Report/gqxm-d9w9) for "COVID-19 Community Profile Report". Each issue of the CPR is made available as an attachment on that page. You can view all attachments by scrolling to the bottom of the "About this dataset" panel and clicking "Show more". diff --git a/docs/api/covidcast-signals/ght.md b/docs/api/covidcast-signals/ght.md index 2e52c2d82..babc6fcc6 100644 --- a/docs/api/covidcast-signals/ght.md +++ b/docs/api/covidcast-signals/ght.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `ght` | | **Data Source** | Google Health Trends | -| **Geographic Coverage** | State, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA), Designated Marketing Area (DMA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2021-03-04 | -| **Earliest Date** | 2020-02-01 | +| **Geographic Levels** | State, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA), Designated Marketing Area (DMA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated since 2021-03-04 | +| **Temporal Scope Start** | 2020-02-01 | | **License** | [Google Terms of Service](https://policies.google.com/terms)| ## Overview diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md index a57bf0afd..ccf53ffbc 100644 --- a/docs/api/covidcast-signals/google-survey.md +++ b/docs/api/covidcast-signals/google-survey.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `google-survey` | | **Data Source** | [Google-run symptom surveys](https://9to5google.com/2020/03/23/google-coronavirus-survey/)/Delphi | -| **Geographic Coverage** | National, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2020-05-14 | -| **Earliest Date** | 2020-04-11 | +| **Geographic Levels** | National, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated since 2020-05-14 | +| **Temporal Scope Start** | 2020-04-11 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | ## Overview diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index f6c1e09ad..b326e72c1 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -12,12 +12,12 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `google-symptoms` | | **Data Source** | Google | -| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Earliest Date** | 2020-02-13, with some variation depending on geographic area| +| **Geographic Levels** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Temporal Scope Start** | 2020-02-13, with some variation depending on geographic area| | **License** | [Google Terms of Service](https://policies.google.com/terms) | - + ## Overview {: .no_toc} diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index c2cbb50b6..697e3bf9d 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `hhs` | | **Data Source** | U.S. Department of Health & Human Services | -| **Geographic Coverage** | National, U.S. HHS Region, State (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - no longer updated since 2024-04-30 | -| **Earliest Date** | 2019-12-31 | +| **Geographic Levels** | National, U.S. HHS Region, State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - no longer updated since 2024-04-30 | +| **Temporal Scope Start** | 2019-12-31 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | The U.S. Department of Health & Human Services (HHS) publishes several diff --git a/docs/api/covidcast-signals/hospital-admissions.md b/docs/api/covidcast-signals/hospital-admissions.md index 6d2b9c7db..41c22a653 100644 --- a/docs/api/covidcast-signals/hospital-admissions.md +++ b/docs/api/covidcast-signals/hospital-admissions.md @@ -11,10 +11,10 @@ nav_order: 1 | Attribute | Details | | :--- | :--- | | **Data Source** | Health system partners | -| **Geographic Coverage** | National, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Daily | -| **Earliest Date** | 2020-02-01 | +| **Geographic Levels** | National, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Daily | +| **Temporal Scope Start** | 2020-02-01 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index 9cae4dabb..0d51fdbb3 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `indicator-combination` | | **Data Source** | Delphi | -| **Geographic Coverage** | State, County, Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - no longer updated since 2021-03-16 | -| **Earliest Date** | 2020-04-06 | +| **Geographic Levels** | State, County, Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - no longer updated since 2021-03-16 | +| **Temporal Scope Start** | 2020-04-06 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | ## Overview diff --git a/docs/api/covidcast-signals/jhu-csse.md b/docs/api/covidcast-signals/jhu-csse.md index c80dfc5cd..1c067f4d4 100644 --- a/docs/api/covidcast-signals/jhu-csse.md +++ b/docs/api/covidcast-signals/jhu-csse.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `jhu-csse` | | **Data Source** | JHU CSSE | -| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2023-03-09 | -| **Earliest Date** | 2020-01-22, with some variation by geographic area | +| **Geographic Levels** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated since 2023-03-09 | +| **Temporal Scope Start** | 2020-01-22, with some variation by geographic area | | **License** | [CC BY](#source-and-licensing) | ## Overview diff --git a/docs/api/covidcast-signals/nchs-mortality.md b/docs/api/covidcast-signals/nchs-mortality.md index 33f85ab53..280661c53 100644 --- a/docs/api/covidcast-signals/nchs-mortality.md +++ b/docs/api/covidcast-signals/nchs-mortality.md @@ -12,10 +12,10 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `nchs-mortality` | | **Data Source** | [National Center for Health Statistics (NCHS)](https://www.cdc.gov/nchs/nvss/vsrr/COVID19/index.htm) | -| **Geographic Coverage** | State (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Weekly (see [date format docs](../covidcast_times.md))| -| **Update Frequency** | Weekly | -| **Earliest Date** | 2020w05 with some variation by geography | +| **Geographic Levels** | State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Weekly (see [date format docs](../covidcast_times.md))| +| **Reporting Cadence** | Weekly | +| **Temporal Scope Start** | 2020w05 with some variation by geography | | **License** | [NCHS Data Use Agreement](https://www.cdc.gov/nchs/data_access/restrictions.htm) | This data source of national provisional death counts is based on death diff --git a/docs/api/covidcast-signals/nhsn.md b/docs/api/covidcast-signals/nhsn.md index d24078329..c60066959 100644 --- a/docs/api/covidcast-signals/nhsn.md +++ b/docs/api/covidcast-signals/nhsn.md @@ -11,10 +11,10 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `nhsn` | | **Data Source** | [The National Healthcare Safety Network (NHSN)](https://www.cdc.gov/nhsn/index.html) | -| **Geographic Coverage** | National, U.S. HHS Region, State (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Weekly (Sunday to Saturday) (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Weekly | -| **Earliest Date** | 2020-08-08 | +| **Geographic Levels** | National, U.S. HHS Region, State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Weekly (Sunday to Saturday) (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Weekly | +| **Temporal Scope Start** | 2020-08-08 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | ## Overview diff --git a/docs/api/covidcast-signals/nssp.md b/docs/api/covidcast-signals/nssp.md index 41798735e..3d00ac0a2 100644 --- a/docs/api/covidcast-signals/nssp.md +++ b/docs/api/covidcast-signals/nssp.md @@ -11,10 +11,10 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `nssp` | | **Data Source** | [The National Syndromic Surveillance Program (NSSP)](https://www.cdc.gov/nssp/php/about/index.html) | -| **Geographic Coverage** | National, U.S. HHS Region, State (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Weekly (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Weekly | -| **Earliest Date** | 2022-10-01 | +| **Geographic Levels** | National, U.S. HHS Region, State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Weekly (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Weekly | +| **Temporal Scope Start** | 2022-10-01 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | ## Overview diff --git a/docs/api/covidcast-signals/quidel.md b/docs/api/covidcast-signals/quidel.md index 44c155652..b176f0599 100644 --- a/docs/api/covidcast-signals/quidel.md +++ b/docs/api/covidcast-signals/quidel.md @@ -24,10 +24,10 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `quidel` | | **Data Source** | QuidelOrtho Corp. | -| **Geographic Coverage** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Daily | -| **Earliest Date** | 2020-05-26 | +| **Geographic Levels** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Daily | +| **Temporal Scope Start** | 2020-05-26 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | ### Overview @@ -174,10 +174,10 @@ These signals are inactive. They were updated until May 19, 2020. | :--- | :--- | | **Source Name** | `quidel` | | **Data Source** | QuidelOrtho Corp. | -| **Geographic Coverage** | State, Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2020-05-01 | -| **Earliest Date** | 2020-01-31 | +| **Geographic Levels** | State, Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated since 2020-05-01 | +| **Temporal Scope Start** | 2020-01-31 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index b0dc171ad..61e2b603b 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `safegraph` | | **Data Source** | SafeGraph | -| **Geographic Coverage** | State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md))| -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive | -| **Earliest Date** | 2019-01-01 | +| **Geographic Levels** | State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md))| +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive | +| **Temporal Scope Start** | 2019-01-01 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | This data source uses data reported by [SafeGraph](https://www.safegraph.com/) diff --git a/docs/api/covidcast-signals/usa-facts.md b/docs/api/covidcast-signals/usa-facts.md index 4767672fe..40bd3e549 100644 --- a/docs/api/covidcast-signals/usa-facts.md +++ b/docs/api/covidcast-signals/usa-facts.md @@ -12,10 +12,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `usa-facts` | | **Data Source** | [USAFacts](https://usafacts.org/) | -| **Geographic Coverage** | National, U.S. HHS Region, State/ADM 1, County/ADM 2, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated since 2023-01-02 | -| **Earliest Date** | 2020-01-25 | +| **Geographic Levels** | National, U.S. HHS Region, State/ADM 1, County/ADM 2, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated since 2023-01-02 | +| **Temporal Scope Start** | 2020-01-25 | | **License** | [CC BY](#source-and-licensing) | This data source of confirmed COVID-19 cases and deaths is based on reports made diff --git a/docs/api/covidcast-signals/youtube-survey.md b/docs/api/covidcast-signals/youtube-survey.md index 2364bbfbc..62f6ec660 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -14,12 +14,12 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `youtube-survey` | | **Data Source** | Google/Delphi | -| **Geographic Coverage** | State (see [geography coding docs](../covidcast_geography.md)) | -| **Temporal Resolution** | Daily (see [date format docs](../covidcast_times.md)) | -| **Update Frequency** | Inactive - No longer updated | +| **Geographic Levels** | State (see [geography coding docs](../covidcast_geography.md)) | +| **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | +| **Reporting Cadence** | Inactive - No longer updated | | **License** | [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) | - + ## Overview From d6122aafdf4c29d2198a3da5b27f62a6019ab7eb Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 9 Dec 2025 12:11:02 -0800 Subject: [PATCH 50/64] docs: fix headers to align with epiportal categories in other endpoints and indicate date formats --- docs/api/01meta.md | 9 ++-- docs/api/README.md | 33 ++++++--------- docs/api/cdc.md | 11 +++-- docs/api/covid_hosp.md | 13 +++--- docs/api/covid_hosp_facility.md | 8 ++-- docs/api/covid_hosp_facility_lookup.md | 8 ++-- docs/api/covidcast_meta.md | 1 - docs/api/covidcast_times.md | 2 +- docs/api/date_formats.md | 53 ++++++++++++++++++++++++ docs/api/delphi.md | 24 ++++++++--- docs/api/dengue_digital_surveillance.md | 29 +++++++++---- docs/api/dengue_nowcast.md | 11 +++-- docs/api/digital_surveillance_sensors.md | 11 +++-- docs/api/ecdc_ili.md | 13 +++--- docs/api/fluview.md | 13 +++--- docs/api/fluview_clinical.md | 13 +++--- docs/api/fluview_meta.md | 2 - docs/api/gft.md | 9 ++-- docs/api/ght.md | 11 +++-- docs/api/ili_nearby_nowcast.md | 11 +++-- docs/api/kcdc_ili.md | 13 +++--- docs/api/nidss_dengue.md | 11 +++-- docs/api/nidss_flu.md | 13 +++--- docs/api/norostat.md | 11 +++-- docs/api/norostat_meta.md | 3 +- docs/api/paho_dengue.md | 11 +++-- docs/api/quidel.md | 10 ++--- docs/api/twitter.md | 13 +++--- docs/api/wiki.md | 13 +++--- 29 files changed, 219 insertions(+), 164 deletions(-) create mode 100644 docs/api/date_formats.md diff --git a/docs/api/01meta.md b/docs/api/01meta.md index f918f24fe..7e20ca30e 100644 --- a/docs/api/01meta.md +++ b/docs/api/01meta.md @@ -18,13 +18,13 @@ General topics not specific to any particular endpoint are discussed in the ## API Metadata -... +Overview of the current state of the database, including the latest update times and data volume for specific endpoints. # The API The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. +See [this documentation](date_formats.html) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -36,7 +36,10 @@ None. |-----------|-----------------------------------------------------------------|------------------| | `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer | | `epidata` | list of results | array of objects | -| ... | ... | ... | +| `epidata[].fluview` | Metadata for [FluView](fluview.md) | array of objects | +| `epidata[].twitter` | Metadata for [Twitter](twitter.md) | array of objects | +| `epidata[].wiki` | Metadata for [Wikipedia](wiki.md) | array of objects | +| `epidata[].delphi` | Metadata for [Delphi Forecasts](delphi.md) | array of objects | | `message` | `success` or error message | string | # Example URLs diff --git a/docs/api/README.md b/docs/api/README.md index 73de62dce..b5e75620d 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -75,19 +75,12 @@ The base URL is: ## Specifying Epiweeks, Dates, and Lists -Epiweeks use the U.S. definition. That is, the first epiweek each year is the -week, starting on a Sunday, containing January 4. See -[this page](https://www.cmmcp.org/mosquito-surveillance-data/pages/epi-week-calendars-2008-2020) -for more information. - Formatting for epiweeks is YYYYWW and for dates is YYYYMMDD. -`list` parameters consist of a comma-separated list of individual values or, for numeric parameters, a hyphenated range of values. Examples include: - - `param=201530` *(A single epiweek)* - - `param=201401,201501,201601` *(Several epiweeks)* - - `param=200501-200552` *(A range of epiweeks)* - - `param=201440,201501-201510` *(Several epiweeks, including a range)* - - `param=20070101-20071231` *(A range of dates)* +See [Date Formats](date_formats.html) for full details on specifying epiweeks, dates, lists, and ranges. + +`list` parameters consist of a comma-separated list of individual values or, for numeric parameters, a hyphenated range of values. + ## Universal Parameters @@ -111,8 +104,8 @@ The parameters available for each source are documented in each linked source-sp | Endpoint | Name | Description | Restricted? | | --- | --- | --- | --- | -| [`cdc`](cdc.md) | CDC Page Hits | ... | yes | -| [`delphi`](delphi.md) | Delphi's Forecast | ... | no | +| [`cdc`](cdc.md) | CDC Page Hits | CDC total and by topic webpage visits. | yes | +| [`delphi`](delphi.md) | Delphi's Forecast | Delphi's ILINet outpatient doctor visits forecasts. | no | | [`ecdc_ili`](ecdc_ili.md) | ECDC ILI | ECDC ILI data from the ECDC website. | no | | [`flusurv`](flusurv.md) | FluSurv | FluSurv-NET data (flu hospitaliation rates) from CDC. | no | | [`fluview`](fluview.md) | FluView | Influenza-like illness (ILI) from U.S. Outpatient Influenza-like Illness Surveillance Network (ILINet). | no | @@ -125,7 +118,7 @@ The parameters available for each source are documented in each linked source-sp | [`nidss_flu`](nidss_flu.md) | NIDSS Flu | Outpatient ILI from Taiwan's National Infectious Disease Statistics System (NIDSS). | no | | [`nowcast`](nowcast.md) | ILI Nearby | A nowcast of U.S. national, regional, and state-level (weighted) percent ILI, available seven days (regionally) or five days (state-level) before the first ILINet report for the corresponding week. | no | | [`quidel`](quidel.md) | Quidel | Data provided by Quidel Corp., which contains flu lab test results. | yes | -| [`sensors`](sensors.md) | Delphi's Digital Surveillance Sensors | Digital surveillance signals for influenza. | no | +| [`sensors`](sensors.html) | Delphi's Digital Surveillance Sensors | Influenza and dengue digital surveillance sensors. | partially | | [`twitter`](twitter.md) | Twitter Stream | Estimate of influenza activity based on analysis of language used in tweets from [HealthTweets](http://HealthTweets.org/). | yes | | [`wiki`](wiki.md) | Wikipedia Access Logs | Number of page visits for selected English, Influenza-related wikipedia articles. | no | @@ -133,17 +126,17 @@ The parameters available for each source are documented in each linked source-sp | Endpoint | Name | Description | Restricted? | | --- | --- | --- | --- | -| [`dengue_nowcast`](dengue_nowcast.md) | Delphi's Dengue Nowcast | Nowcast of dengue in Puerto Rico and other regions. |... | -| [`dengue_sensors`](dengue_sensors.md) | Delphi's Dengue Digital Surveillance Sensors | Digital surveillance signals for dengue. | ... | -| [`nidss_dengue`](nidss_dengue.md) | NIDSS Dengue | Counts of confirmed dengue cases from Taiwan's NIDSS. | no | -| [`paho_dengue`](paho_dengue.md) | PAHO Dengue | Dengue cases reported by PAHO. | ... | +| [`dengue_nowcast`](dengue_nowcast.md) | Delphi's Dengue Nowcast | Delphi's PAHO dengue nowcasts (North and South America). | no | +| [`dengue_sensors`](dengue_sensors.md) | Delphi's Dengue Digital Surveillance Sensors | PAHO dengue digital surveillance sensors (North and South America). | yes | +| [`nidss_dengue`](nidss_dengue.md) | NIDSS Dengue | NIDSS dengue cases (Taiwan). | no | +| [`paho_dengue`](paho_dengue.md) | PAHO Dengue | PAHO dengue data (North and South America). | no | ### Norovirus Data | Endpoint | Name | Description | Restricted? | | --- | --- | --- | --- | -| [`meta_norostat`](meta_norostat.md) | NoroSTAT Metadata | Metadata for NoroSTAT data. | ... | -| [`norostat`](norostat.md) | NoroSTAT | Suspected and confirmed norovirus outbreaks reported by state health departments to the CDC. | ... | +| [`meta_norostat`](meta_norostat.md) | NoroSTAT Metadata | Metadata for the NoroSTAT endpoint. | yes | +| [`norostat`](norostat.md) | NoroSTAT | CDC NoroSTAT norovirus outbreaks. | yes | ### Deprecated * `ilinet` - replaced by [`fluview`](fluview.md) diff --git a/docs/api/cdc.md b/docs/api/cdc.md index 5f570bec6..9e7a0e57b 100644 --- a/docs/api/cdc.md +++ b/docs/api/cdc.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `cdc` | | **Data Source** | CDC influenza surveillance data | -| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2020w03 (2020-01-12) | -| **Earliest Date** | 2013w02 (2013-01-06) | +| **Geographic Levels** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w03 (2020-01-12) | +| **Temporal Scope Start** | 2013w02 (2013-01-06) | @@ -41,7 +41,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -50,7 +49,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `auth` | password | string | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `list` of location codes: `nat` (national), HHS regions (`hhs1`-`hhs10`), Census divisions (`cen1`-`cen9`), or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ## Response diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md index 8fecb03f7..70fe0239c 100644 --- a/docs/api/covid_hosp.md +++ b/docs/api/covid_hosp.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `covid_hosp_state_timeseries` | | **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) | -| **Geographic Coverage** | US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | -| **Temporal Resolution** | Daily | -| **Update Frequency** | Inactive - No longer updated since 2024-04-27 | -| **Earliest Date** | 2020-01-01 | +| **Geographic Levels** | US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | +| **Temporal Granularity** | Daily | +| **Reporting Cadence** | Inactive - No longer updated since 2024-04-27 | +| **Temporal Scope Start** | 2020-01-01 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | ## Overview @@ -55,7 +55,6 @@ General topics not specific to any particular data source are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying locations and dates. ## Parameters @@ -64,13 +63,13 @@ See [this documentation](README.md) for details on specifying locations and date | Parameter | Description | Type | |-----------|--------------------------------|--------------------------------| | `states` | two-letter state abbreviations (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | `list` of states | -| `dates` | dates | `list` of dates or date ranges | +| `dates` | dates (see [Date Formats](date_formats.md)) | `list` of dates or date ranges | ### Optional | Parameter | Description | Type | |-----------|-------------|----------------------------------------| -| `issues` | issues | `list` of "issue" dates or date ranges | +| `issues` | issues (see [Date Formats](date_formats.md)) | `list` of "issue" dates or date ranges | If `issues` is not specified, then the most recent issue is used by default. diff --git a/docs/api/covid_hosp_facility.md b/docs/api/covid_hosp_facility.md index eec828c0e..17fe7664c 100644 --- a/docs/api/covid_hosp_facility.md +++ b/docs/api/covid_hosp_facility.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `covid_hosp_facility` | | **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) | -| **Geographic Coverage** | Healthcare facility | -| **Temporal Resolution** | Weekly (Friday -- Thursday) | -| **Update Frequency** | Inactive - No longer updated since 2024w08 | -| **Earliest Date** | 2020-07-31 | +| **Geographic Levels** | Healthcare facility | +| **Temporal Granularity** | Weekly (Friday -- Thursday) | +| **Reporting Cadence** | Inactive - No longer updated since 2024w08 | +| **Temporal Scope Start** | 2020-07-31 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | ## Overview diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md index 20e3e7fa9..50c74ac5f 100644 --- a/docs/api/covid_hosp_facility_lookup.md +++ b/docs/api/covid_hosp_facility_lookup.md @@ -13,12 +13,12 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `covid_hosp_facility_lookup` | | **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) | -| **Geographic Coverage** | Healthcare facility ([state](geographic_codes.html#us-states-and-territories), ccn city, zip, fips) | -| **Update Frequency** | Inactive - No longer updated since 2024w08 | +| **Geographic Levels** | Healthcare facility ([state](geographic_codes.html#us-states-and-territories), ccn city, zip, fips) | +| **Reporting Cadence** | Inactive - No longer updated since 2024w08 | | **License** | [Public Domain US Government](https://www.usa.gov/government-works) | - + ## Overview {: .no_toc} diff --git a/docs/api/covidcast_meta.md b/docs/api/covidcast_meta.md index 0f006abe9..736cafcbf 100644 --- a/docs/api/covidcast_meta.md +++ b/docs/api/covidcast_meta.md @@ -16,7 +16,6 @@ geographic levels at which they are reported. The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ### Parameters diff --git a/docs/api/covidcast_times.md b/docs/api/covidcast_times.md index 0eace1551..caabfb39a 100644 --- a/docs/api/covidcast_times.md +++ b/docs/api/covidcast_times.md @@ -39,7 +39,7 @@ The available time types include: * `week`: A weekly observation, recording events over 7 days. The `time_value` and `issue` are reported with a year and a week number ranging from 1 to 53, in `YYYYWW` format. These weeks are [MMWR - weeks](https://wwwn.cdc.gov/nndss/document/MMWR_Week_overview.pdf) as defined + weeks](https://ndc.services.cdc.gov/wp-content/uploads/MMWR_week_overview.pdf) as defined by the National Notifiable Diseases Surveillance System, also known as "epiweeks". (The [API clients](covidcast_clients.md) convert these into date objects representing the first day of the MMWR week, and for those not using diff --git a/docs/api/date_formats.md b/docs/api/date_formats.md new file mode 100644 index 000000000..98569e036 --- /dev/null +++ b/docs/api/date_formats.md @@ -0,0 +1,53 @@ +--- +title: Date Formats +parent: Other Endpoints (COVID-19 and Other Diseases) +nav_order: 101 +--- + +# Date Formats +{: .no_toc} + +This page documents the valid date and time formats accepted by various API endpoints. + +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + +## Epiweeks + +Epiweeks (Epidemiological Weeks) use the [U.S. CDC definition](https://ndc.services.cdc.gov/wp-content/uploads/MMWR_week_overview.pdf). That is, the first epiweek each year is the week, starting on a Sunday, containing January 4. + +**Format:** `YYYYWW` +* `YYYY`: Four-digit year +* `WW`: Two-digit week (01-53) + +Example: `201501` represents the first epiweek of 2015. + +See [this page](https://www.cmmcp.org/mosquito-surveillance-data/pages/epi-week-calendars-2008-2020) for more information and calendars. + +## Dates + +Dates generally follow the ISO 8601 basic format, but without hyphens. + +**Format:** `YYYYMMDD` +* `YYYY`: Four-digit year +* `MM`: Two-digit month (01-12) +* `DD`: Two-digit day (01-31) + +Example: `20150201` represents February 1st, 2015. + +## Specifying Lists and Ranges + +Many API parameters accept lists of values or ranges. + +`list` parameters consist of a comma-separated list of individual values or, for numeric parameters (like epiweeks or dates), a hyphenated range of values. + +**Examples:** + +* **Single Value:** `param=201530` +* **List of Values:** `param=201401,201501,201601` +* **Range:** `param=200501-200552` +* **Mixed List and Range:** `param=201440,201501-201510` +* **Date Range:** `param=20070101-20071231` diff --git a/docs/api/delphi.md b/docs/api/delphi.md index 168218005..6b06d820a 100644 --- a/docs/api/delphi.md +++ b/docs/api/delphi.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `delphi` | | **Data Source** | [Delphi](https://delphi.cmu.edu/) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Systems available** | `af`, `eb`, `ec`, `sp`, `st` | -| **Update Frequency** | Inactive - No longer updated since 2020w19 | -| **Earliest Date** | 2014w41 | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Systems available** | `af`, `eb`, `ec`, `sp`, `st` (see [details below](#forecasting-systems)) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w19 | +| **Temporal Scope Start** | Varies by system (earliest 2014w41) | | **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | ## Overview @@ -29,6 +29,19 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). +### Forecasting Systems + +The following systems are available, representing different forecasting models for ILINet % weighted ILI: + +| Code | Name | +| :--- | :--- | +| `af` | [Archefilter](http://reports-archive.adm.cs.cmu.edu/anon/cbd/CMU-CB-16-101.pdf#Appendix.1.B) | +| `eb` | [Empirical Bayes](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1004382) | +| `ec` | [Epicast](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005248) | +| `sp` | [Pinned Spline](http://reports-archive.adm.cs.cmu.edu/anon/cbd/CMU-CB-16-101.pdf#Appendix.1.A) | +| `st` | [Delphi-Stat](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1006134) + + ## Table of contents {: .no_toc .text-delta} @@ -39,7 +52,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -48,7 +60,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | |-----------|-------------|--------------------------------------| | `system` | system | system name (`af`, `eb`, `ec`, `sp`, `st`) | -| `epiweek` | epiweek | epiweek when forecast was made | +| `epiweek` | epiweek (see [Date Formats](date_formats.html)) | epiweek when forecast was made | ## Response diff --git a/docs/api/dengue_digital_surveillance.md b/docs/api/dengue_digital_surveillance.md index ff9b664ec..fc6bc7223 100644 --- a/docs/api/dengue_digital_surveillance.md +++ b/docs/api/dengue_digital_surveillance.md @@ -14,10 +14,10 @@ permalink: api/dengue_sensors.html | :--- | :--- | | **Source Name** | `dengue_sensors` | | **Data Source** | Various digital data streams | -| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2020w32| -| **Earliest Date** | 2014w04 | +| **Geographic Levels** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w32| +| **Temporal Scope Start** | 2014w04 | | **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | @@ -31,6 +31,22 @@ General topics not specific to any particular endpoint are discussed in the [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). +### Available Signals + +The following signals are available: + +| Name | Description | +| :--- | :--- | +| `gft` | Google Flu Trends | +| `ght` | Google Health Trends | +| `twtr` | HealthTweets | +| `wiki` | Wikipedia access | +| `cdc` | CDC Page Hits | +| `epic` | Epicast 1-week-ahead point prediction | +| `quid` | Flu lab test data | +| `sar3` | Seasonal Autoregression (order 3) | +| `arch` | Best-fit Archetype at 1-week-ahead | + ## Table of contents {: .no_toc .text-delta} @@ -41,7 +57,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -50,8 +65,8 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `auth` | password | string | -| `epiweeks` | epiweeks | `list` of epiweeks | -| `name` | name | `list` of names (`ght`) | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | +| `name` | name | `list` of names (see [Available Signals](#available-signals)) | | `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) | diff --git a/docs/api/dengue_nowcast.md b/docs/api/dengue_nowcast.md index f8a25f83b..511fdd6f2 100644 --- a/docs/api/dengue_nowcast.md +++ b/docs/api/dengue_nowcast.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `dengue_nowcast` | | **Data Source** | [Delphi](https://delphi.cmu.edu/) | -| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2020w32 | -| **Earliest Date** | 2014w09 | +| **Geographic Levels** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w32 | +| **Temporal Scope Start** | 2014w09 | | **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | @@ -40,7 +40,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -48,7 +47,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) | ## Response diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index 698468cea..96a32c542 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -13,10 +13,10 @@ permalink: api/sensors.html | :--- | :--- | | **Source Name** | `sensors` | | **Data Source** | Various digital data streams | -| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2022w36 | -| **Earliest Date** | 2010w40 | +| **Geographic Levels** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2022w36 | +| **Temporal Scope Start** | 2010w40 | | **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | This is the documentation of the API for accessing the Digital Surveillance Sensors (`sensors`) endpoint of @@ -42,7 +42,6 @@ the COVID-19 pandemic. The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -50,7 +49,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `list` of location codes: `nat`, HHS regions, Census divisions, or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | `names` | sensor names | `list` of string | diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index c8e3d0f91..d641a67be 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `ecdc_ili` | | **Data Source** | [European Centre for Disease Prevention and Control (ECDC)](https://www.ecdc.europa.eu/en/home) | -| **Geographic Coverage** | European countries (see [Geographic Codes](geographic_codes.html#european-countries)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2020w12 | -| **Earliest Date** | 2018w40 | +| **Geographic Levels** | European countries (see [Geographic Codes](geographic_codes.html#european-countries)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w12 | +| **Temporal Scope Start** | 2018w40 | | **License** | This was scraped from a publicly-accessible website, but no explicit license terms were found. | @@ -42,7 +42,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -50,14 +49,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `regions` | regions | `list` of European country labels (see [Geographic Codes](geographic_codes.html#european-countries)) | ### Optional | Parameter | Description | Type | | --- | --- | --- | -| `issues` | issues | `list` of epiweeks | +| `issues` | issues (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `lag` | # weeks between each epiweek and its issue | integer | {: .note} diff --git a/docs/api/fluview.md b/docs/api/fluview.md index 022824177..6df453000 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -13,10 +13,10 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `fluview` | | **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | -| **Geographic Coverage** | National, states, HHS regions, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Weekly (typically Fridays) | -| **Earliest Date** | 1997w40 | +| **Geographic Levels** | National, states, HHS regions, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Weekly (typically Fridays) | +| **Temporal Scope Start** | 1997w40 | | **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | ## Overview @@ -39,7 +39,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -47,14 +46,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `regions` | regions | `list` of region labels: `nat`, states, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ### Optional | Parameter | Description | Type | |-----------|--------------------------------------------|--------------------| -| `issues` | issues | `list` of epiweeks | +| `issues` | issues (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `lag` | # weeks between each epiweek and its issue | integer | | `auth` | password for private imputed data | string | diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index 61c6556e5..96b0f84bf 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -13,10 +13,10 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `fluview_clinical` | | **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | -| **Geographic Coverage** | National, HHS regions, states, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Weekly (typically Fridays) | -| **Earliest Date** | 2016w40 | +| **Geographic Levels** | National, HHS regions, states, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Weekly (typically Fridays) | +| **Temporal Scope Start** | 2016w40 | | **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | @@ -41,7 +41,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -49,14 +48,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `regions` | regions | `list` of region labels: `nat`, states, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ### Optional | Parameter | Description | Type | |-----------|--------------------------------------------|--------------------| -| `issues` | issues | `list` of epiweeks | +| `issues` | issues (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `lag` | # weeks between each epiweek and its issue | integer | {: .note} diff --git a/docs/api/fluview_meta.md b/docs/api/fluview_meta.md index 4e98e5440..831e65439 100644 --- a/docs/api/fluview_meta.md +++ b/docs/api/fluview_meta.md @@ -12,7 +12,6 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `fluview_meta` | | **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | -| **Update Frequency** | Weekly (typically Fridays) | | **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | ## Overview @@ -41,7 +40,6 @@ Returns information about the [`fluview` endpoint](fluview.md). The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters diff --git a/docs/api/gft.md b/docs/api/gft.md index 84439c795..e5046f550 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `gft` | | **Data Source** | [Google Flu Trends Estimates](https://www.google.com/publicdata/explore?ds=z3bsqef7ki44ac_) ([context](https://en.wikipedia.org/wiki/Google_Flu_Trends)) | -| **Geographic Coverage** | National, HHS regions, US states (see [US Regions and States](geographic_codes.html#us-regions-and-states)), and select cities (see [Selected US Cities](geographic_codes.html#selected-us-cities)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2015w32 | -| **Earliest Date** | 2003w40 | +| **Geographic Levels** | National, HHS regions, US states (see [US Regions and States](geographic_codes.html#us-regions-and-states)), and select cities (see [Selected US Cities](geographic_codes.html#selected-us-cities)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2015w32 | +| **Temporal Scope Start** | 2003w40 | | **License** | [Google Terms of Service](https://policies.google.com/terms) | @@ -40,7 +40,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters diff --git a/docs/api/ght.md b/docs/api/ght.md index bc688c7eb..1d434cbb9 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `ght` | | **Data Source** | Google Health Trends | -| **Geographic Coverage** | [US States](geographic_codes.html#us-states-and-territories) and national level (US) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2022w36 | -| **Earliest Date** | 1993w01 | +| **Geographic Levels** | [US States](geographic_codes.html#us-states-and-territories) and national level (US) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2022w36 | +| **Temporal Scope Start** | 1993w01 | | **License** | [Google Terms of Service](https://policies.google.com/terms) | This is the API documentation for accessing the Google Health Trends (`ght`) @@ -44,7 +44,6 @@ This data may be useful for real-time monitoring of diseases, as in: The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -53,7 +52,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `auth` | password | string | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `list` of state codes (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) and/or `US` | | `query` | search query or topic ID | string | diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index 669600d6e..25781fab4 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -15,10 +15,10 @@ permalink: api/nowcast.html | **Source Name** | `nowcast` | | **Data Source** | [Delphi's ILI Nearby system](https://delphi.cmu.edu/nowcast/) | | **Dataset Type** | Predictive (Leading Indicator) | -| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2022w36 | -| **Earliest Date** | 2010w45 | +| **Geographic Levels** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2022w36 | +| **Temporal Scope Start** | 2010w45 | | **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) | ## Overview @@ -46,7 +46,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -54,7 +53,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `list` of location codes: `nat`, HHS regions, Census divisions, or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | ## Response diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index 0f1d0b1f5..d3a7eab28 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `kcdc_ili` | | **Data Source** | [Korea Disease Control and Prevention Agency (KCDC) ILI surveillance](https://www.kdca.go.kr/) | -| **Geographic Coverage** | ROK (Republic of Korea) (see [Geographic Codes](geographic_codes.md#republic-of-korea)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2020w44 | -| **Earliest Date** | 2004w36 | +| **Geographic Levels** | ROK (Republic of Korea) (see [Geographic Codes](geographic_codes.md#republic-of-korea)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w44 | +| **Temporal Scope Start** | 2004w36 | | **License** | This was scraped from a publicly-accessible government website, but no explicit license terms were found. | ## Overview @@ -42,7 +42,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -57,8 +56,8 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `issues` | Optionally, the issue(s) of the data to fetch. See the "Data Versioning" section for details. | `list` of epiweeks | -| `lag` | Optionally, the lag of the issues to fetch. See the "Data Versioning" section for details. | integer | +| `issues` | Optionally, the issue(s) (see [Date Formats](date_formats.html)) of the data to fetch. | `list` of epiweeks | +| `lag` | Optionally, the lag of the issues to fetch. | integer | {: .note} > **Notes:** diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 8b6fad444..34264d8cb 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `nidss_dengue` | | **Data Source** | [Taiwan CDC](http://nidss.cdc.gov.tw/en/SingleDisease.aspx?dc=1&dt=4&disease=061&position=1)| -| **Geographic Coverage** | Taiwan regions and cities/counties (see [Geographic Codes](geographic_codes.html#nidss)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2018w10 | -| **Earliest Date** | 2003w01 | +| **Geographic Levels** | Taiwan regions and cities/counties (see [Geographic Codes](geographic_codes.html#nidss)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2018w10 | +| **Temporal Scope Start** | 2003w01 | | **License** | [Open Access](https://data.gov.tw/license) | ## Overview @@ -41,7 +41,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -49,7 +48,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `list` of Taiwan region and/or location labels (see [Geographic Codes](geographic_codes.html#nidss)) | ## Response diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index 19b7539a3..6d19e7ebe 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `nidss_flu` | | **Source** | [Taiwan CDC](http://nidss.cdc.gov.tw/en/CDCWNH01.aspx?dc=wnh) | -| **Geographic Coverage** | Taiwan regions (see [Geographic Codes](geographic_codes.html#taiwan-regions)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2018w10 | -| **Earliest Date** | 2008w14 | +| **Geographic Levels** | Taiwan regions (see [Geographic Codes](geographic_codes.html#taiwan-regions)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2018w10 | +| **Temporal Scope Start** | 2008w14 | | **License** | [Open Access](https://data.gov.tw/license) | ## Overview @@ -42,7 +42,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -50,14 +49,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `regions` | regions | `list` of Taiwan region labels (see [Geographic Codes](geographic_codes.html#taiwan-regions)) | ### Optional | Parameter | Description | Type | |-----------|--------------------------------------------|--------------------| -| `issues` | issues | `list` of epiweeks | +| `issues` | issues (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `lag` | # weeks between each epiweek and its issue | integer | Notes: diff --git a/docs/api/norostat.md b/docs/api/norostat.md index 6afaacb55..4d7fcb8f5 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.md @@ -14,10 +14,10 @@ nav_order: 2 | **Source Name** | `norostat` | | **Data Source** | [CDC NoroSTAT](https://www.cdc.gov/norovirus/php/reporting/norostat-data.html) metadata endpoint (requires authentication) | | **Dataset Type** | Surveillance (Inactive) | -| **Geographic Coverage** | Only a specific list of full state names are permitted. See the `locations` output of the [meta_norostat](meta_norostat.html#norostat-metadata-1) endpoint for the allowed values. | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2020w30. | -| **Earliest Date** | 2012w31 | +| **Geographic Levels** | Only a specific list of full state names are permitted. See the `locations` output of the [meta_norostat](meta_norostat.html#norostat-metadata-1) endpoint for the allowed values. | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w30. | +| **Temporal Scope Start** | 2012w31 | | **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | ## Overview @@ -41,7 +41,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -50,7 +49,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | | `auth` | password | string | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `string` with specific list of full state names | ## Response diff --git a/docs/api/norostat_meta.md b/docs/api/norostat_meta.md index f32e11529..d4e994c08 100644 --- a/docs/api/norostat_meta.md +++ b/docs/api/norostat_meta.md @@ -14,7 +14,7 @@ permalink: api/meta_norostat.html | :--- | :--- | | **Source Name** | `meta_norostat` | | **Data Source** | [CDC NoroSTAT](https://www.cdc.gov/norovirus/php/reporting/norostat-data.html) | -| **Update Frequency** | Inactive - Delphi stopped stopped acquiring data from this data source in November 2020. | +| **Reporting Cadence** | Inactive - Delphi stopped stopped acquiring data from this data source in November 2020. | @@ -36,7 +36,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index f564d3fe2..00db913c9 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `paho_dengue` | | **Data Source** | [Pan American Health Organization (PAHO) Dengue surveillance](https://www.paho.org/en/arbo-portal/dengue-data-and-analysis) | -| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2020w31 | -| **Earliest Date** | 2014w01 | +| **Geographic Levels** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas))
*Note: Data availability varies by country.* | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w31 | +| **Temporal Scope Start** | 2014w01 | | **License** | This was scraped from a publicly-accessible website, but no explicit license terms were found. | ## Overview @@ -41,7 +41,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -49,7 +48,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `regions` | regions | `list` of region labels (see [Geographic Codes](geographic_codes.html#paho-dengue)) | ## Response diff --git a/docs/api/quidel.md b/docs/api/quidel.md index 640db5439..b67f9e791 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `quidel` | | **Data Source** | QuidelOrtho Corp. influenza testing data | -| **Geographic Coverage** | HHS regions (see [Geographic Codes](geographic_codes.html#hhs-regions)) | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2020w15| -| **Earliest Date** | 2015w35 | +| **Geographic Levels** | HHS regions (see [Geographic Codes](geographic_codes.html#hhs-regions)) | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w15| +| **Temporal Scope Start** | 2015w35 | @@ -46,7 +46,7 @@ See this [documentation](https://cmu-delphi.github.io/delphi-epidata/api/README. | Parameter | Description | Type | | --- | --- | --- | | `auth` | password | string | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `list` of `hhs<#>` region labels (see [Geographic Codes](geographic_codes.html#hhs-regions)) | ## Response diff --git a/docs/api/twitter.md b/docs/api/twitter.md index 1044d3266..ed92f9cec 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -13,10 +13,10 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `twitter` | | **Data Source** | [HealthTweets](http://www.healthtweets.org/) | -| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | -| **Temporal Resolution** | Daily and Weekly (Epiweek) | -| **Update Frequency** | Inactive - No longer updated since 2020w31 (2020-12-07)| -| **Earliest Date** | 2011w48 (2011-11-27) | +| **Geographic Levels** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Temporal Granularity** | Daily and Weekly (Epiweek) | +| **Reporting Cadence** | Inactive - No longer updated since 2020w31 (2020-12-07)| +| **Temporal Scope Start** | 2011w48 (2011-11-27) | @@ -43,7 +43,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -53,8 +52,8 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | --- | --- | --- | | `auth` | password | string | | `locations` | locations | `list` of location codes: `nat`, HHS regions, Census divisions, or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | -| `dates` | dates | `list` of dates | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `dates` | dates (see [Date Formats](date_formats.html)) | `list` of dates | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | {: .note} > **Note:** Only one of `dates` and `epiweeks` is required. If both are provided, `epiweeks` is ignored. diff --git a/docs/api/wiki.md b/docs/api/wiki.md index b44215fcc..c9850b2e2 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -13,11 +13,11 @@ nav_order: 2 | :--- | :--- | | **Source Name** | `wiki` | | **Data Source** | [Wikimedia pageviews](https://dumps.wikimedia.org/other/pagecounts-raw/) for health-related Wikipedia articles | -| **Geographic Coverage** | Not applicable (article-based) | -| **Temporal Resolution** | Hourly, Daily, and Weekly (Epiweek) | +| **Geographic Levels** | Not applicable (article-based) | +| **Temporal Granularity** | Hourly, Daily, and Weekly (Epiweek) | | **Available Articles** | [54 health-related articles](wiki_articles.html) | -| **Update Frequency** | Inactive - No longer updated since 2021w11| -| **Earliest Date** | 2007w50 (2007-12-09) | +| **Reporting Cadence** | Inactive - No longer updated since 2021w11| +| **Temporal Scope Start** | 2007w50 (2007-12-09) | | **License** | [CC BY-SA](https://creativecommons.org/licenses/by-sa/4.0/) | @@ -41,7 +41,6 @@ General topics not specific to any particular endpoint are discussed in the The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -51,8 +50,8 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | --- | --- | --- | | `articles` | articles | list of [articles](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/articles.md) | | `language` | language (currently `en`, `es`, and `pt` supported) | string | -| `dates` | dates | `list` of dates | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `dates` | dates (see [Date Formats](date_formats.html)) | `list` of dates | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | ### Optional From 94c6812d51a061411190aabe66b54e9dc22f3a2d Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 9 Dec 2025 12:14:23 -0800 Subject: [PATCH 51/64] docs: update headers to align with epiportal and add details on estimation, processing, Strata definitions, lag, backfill, and limitations for the Flusurv endpoint --- docs/api/flusurv.md | 106 +++++++++++++++++++++++++++++++++++++------- 1 file changed, 91 insertions(+), 15 deletions(-) diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index e7e69e84a..eb43983d9 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -12,11 +12,11 @@ nav_order: 1 | Attribute | Details | | :--- | :--- | | **Source Name** | `flusurv` | -| **Data Source** | [Laboratory-Confirmed Influenza Hospitalizations](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html) | -| **Geographic Coverage** | See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list | -| **Temporal Resolution** | Weekly (Epiweek) | -| **Earliest Date** | 2003w40 | -| **Update Frequency** | Weekly | +| **Data Source** | [CDC FluSurv-NET](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html) | +| **Geographic Levels** | Specific catchment areas (Network, State, or County-level catchments). See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list | +| **Temporal Granularity** | Weekly (Epiweek) | +| **Temporal Scope Start** | 2003w40 | +| **Reporting Cadence** | Weekly | | **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | @@ -25,19 +25,13 @@ nav_order: 1 ## Overview {: .no_toc} -This data source provides laboratory-confirmed influenza hospitalization rates from the FluSurv-NET surveillance system. The data includes age-stratified hospitalization rates and rates by race, sex, and flu type, when available. +This data source provides laboratory-confirmed influenza hospitalization rates from the from the [CDC's Influenza Hospitalization Surveillance Network (FluSurv-NET)](https://www.cdc.gov/fluview/overview/influenza-hospitalization-surveillance.html?CDC_AAref_Val=https://www.cdc.gov/flu/weekly/influenza-hospitalization-surveillance.htm). The data includes age-stratified hospitalization rates and rates by race, sex, and flu type, when available. General topics not specific to any particular endpoint are discussed in the [API overview](README.md). Such topics include: [contributing](README.md#contributing), [citing](README.md#citing), and [data licensing](README.md#data-licensing). -## Table of contents -{: .no_toc .text-delta} - -1. TOC -{:toc} - See also: - - @@ -45,11 +39,93 @@ See also: The US Influenza Hospitalization Surveillance Network. Emerging Infectious Diseases, 21(9), 1543-1550. . +## Table of contents +{: .no_toc .text-delta} + +1. TOC +{:toc} + + +## Estimation + +The rates provided in this dataset are pulled directly from the CDC's GRASP (Geospatial Research, Analysis, and Services Program) API. + +For a specific location and stratum (e.g., Age 0-4), the rate represents the number of residents of the catchment area hospitalized with laboratory-confirmed influenza divided by the total population of that stratum in that catchment area, multiplied by 100,000. + +### Processing Details +The Delphi pipeline scrapes the CDC GRASP API to emulate browser requests. +* **Duplicate Handling:** In rare instances where the source API provides two differing rates for the same location, epiweek, and demographic group, the pipeline is configured to retain the first value returned by the API. +* **Seasonality:** Data is processed based on "seasons" defined by the CDC, but is stored and served by Delphi indexed by Epiweek. + +## Strata Definitions + +The signals are broken down into specific demographic groups. The suffix of the signal name corresponds to the groups below. + +### Age Groups +The dataset includes both historical age groupings (0-4) and newer, more granular groupings (0tlt1, etc.) added in recent years. + +| Signal Suffix | Age Group | +| :--- | :--- | +| `age_0` | 0-4 yr | +| `age_1` | 5-17 yr | +| `age_2` | 18-49 yr | +| `age_3` | 50-64 yr | +| `age_4` | 65+ yr | +| `age_5` | 65-74 yr | +| `age_6` | 75-84 yr | +| `age_7` | 85+ yr | +| `age_0tlt1` | 0 to <1 yr | +| `age_1t4` | 1-4 yr | +| `age_5t11` | 5-11 yr | +| `age_12t17` | 12-17 yr | +| `age_18t29` | 18-29 yr | +| `age_30t39` | 30-39 yr | +| `age_40t49` | 40-49 yr | +| `age_gte75` | >= 75 yr | +| `age_lt18` | < 18 yr | +| `age_gte18` | >= 18 yr | + +### Race and Ethnicity +The dataset tracks 5 specific racial and ethnic groups. + +| Signal Suffix | Group Description | +| :--- | :--- | +| `race_white` | White | +| `race_black` | Black | +| `race_hisp` | Hispanic/Latino | +| `race_asian` | Asian/Pacific Islander | +| `race_natamer` | American Indian/Alaska Native | + +### Sex + +| Signal Suffix | Group Description | +| :--- | :--- | +| `sex_male` | Male | +| `sex_female` | Female | + +### Influenza Type + +| Signal Suffix | Group Description | +| :--- | :--- | +| `flu_a` | Influenza A | +| `flu_b` | Influenza B | + +## Lag and Backfill + +FluSurv-NET data is subject to reporting lags and revisions. The CDC may update past weekly rates as more hospitalization data becomes available or is corrected. + +The Delphi API tracks these changes via the `issue` date (inferred from the `loaddatetime` provided by the CDC API). When new data is fetched from the CDC, if a rate for a past week has changed, the database is updated to reflect the new value, allowing users to query historical versions of the data using the `lag` or `issues` parameters. + +## Limitations + +* This data does not cover the entire United States. It covers specific catchment areas within 13 states (EIP sites) and additional states participating in the IHSP. Rates are representative of these specific populations and may not perfectly generalize to the entire national population. +* As with all surveillance data, recent weeks may be subject to significant backfill. +* Not all strata (e.g., specific age bands or racial groups) may be available for all locations or all historical dates, depending on the data collection practices at the time. + # The API The base URL is: -See [this documentation](README.md) for details on specifying epiweeks, dates, and lists. ## Parameters @@ -57,14 +133,14 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a | Parameter | Description | Type | | --- | --- | --- | -| `epiweeks` | epiweeks | `list` of epiweeks | +| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#flusurv-locations)) | ### Optional | Parameter | Description | Type | |-----------|--------------------------------------------|--------------------| -| `issues` | issues | `list` of epiweeks | +| `issues` | issues (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `lag` | # weeks between each epiweek and its issue | integer | {: .note} From 0826390b2d05ddcb397cea4de41f6fc5ac11f397 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 9 Dec 2025 12:14:52 -0800 Subject: [PATCH 52/64] docs: add glossary page --- docs/api/glossary.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 docs/api/glossary.md diff --git a/docs/api/glossary.md b/docs/api/glossary.md new file mode 100644 index 000000000..206c6f011 --- /dev/null +++ b/docs/api/glossary.md @@ -0,0 +1,16 @@ +--- +title: Glossary (link to Google Doc) +nav_order: 7 +--- + +# Glossary + +This page is currently hosted on [Google Docs](https://docs.google.com/document/d/17tJSp43lNZdZHCzza9_6ZT2gun0gJD_6zlgllmPTg-E/edit?usp=sharing). + + + + + + From 54678f0676d266b9ff9f5225c76fa40e99b70789 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 9 Dec 2025 19:01:43 -0800 Subject: [PATCH 53/64] docs: set valid queries list for wiki and ght --- docs/api/ght.md | 111 +++++++++++++++++++++++- docs/api/wiki.md | 177 +++++++++++++++++++++++++++++++++++++- docs/api/wiki_articles.md | 77 ----------------- 3 files changed, 286 insertions(+), 79 deletions(-) delete mode 100644 docs/api/wiki_articles.md diff --git a/docs/api/ght.md b/docs/api/ght.md index 1d434cbb9..ce199f7ce 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -54,7 +54,116 @@ The base URL is: | `auth` | password | string | | `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | | `locations` | locations | `list` of state codes (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) and/or `US` | -| `query` | search query or topic ID | string | +| `query` | search query or topic ID (see [Valid Queries](#valid-queries)) | string | + +#### Valid Queries + +
+Click to expand full list of valid queries + +* `/m/0cycc` +* `influenza type a` +* `flu duration` +* `flu fever` +* `treating flu` +* `fever flu` +* `flu recovery` +* `braun thermoscan` +* `oscillococcinum` +* `treating the flu` +* `cold or flu` +* `flu versus cold` +* `flu remedies` +* `contagious flu` +* `type a influenza` +* `flu or cold` +* `duration of flu` +* `cold versus flu` +* `flu cough` +* `flu headache` +* `thermoscan` +* `influenza incubation period` +* `flu lasts` +* `length of flu` +* `flu stomach` +* `cold vs flu` +* `flu and fever` +* `getting over the flu` +* `influenza a` +* `treatment for flu` +* `flu length` +* `treatment for the flu` +* `influenza symptoms` +* `over the counter flu` +* `flu complications` +* `cold and flu symptoms` +* `influenza incubation` +* `treatment of flu` +* `human temperature` +* `low body` +* `flu contagious` +* `robitussin ac` +* `flu how long` +* `ear thermometer` +* `flu contagious period` +* `treat flu` +* `cough flu` +* `low body temperature` +* `expectorant` +* `flu and cold` +* `rapid flu` +* `flu vs. cold` +* `how to treat the flu` +* `how long does the flu last?` +* `viral pneumonia` +* `flu in kids` +* `type a flu` +* `influenza treatment` +* `fighting the flu` +* `flu relief` +* `treat the flu` +* `flu medicine` +* `dangerous fever` +* `what is influenza` +* `tussin` +* `low body temp` +* `flu care` +* `flu in infants` +* `flu dizziness` +* `feed a fever` +* `flu vs cold` +* `flu vomiting` +* `bacterial pneumonia` +* `flu activity` +* `flu chills` +* `anas barbariae` +* `flu germs` +* `tylenol cold` +* `how to get over the flu` +* `flu in children` +* `influenza a and b` +* `duration of the flu` +* `cold symptoms` +* `flu report` +* `rapid flu test` +* `flu relapse` +* `get over the flu` +* `flu during pregnancy` +* `flu recovery time` +* `cure for flu` +* `tamiflu and breastfeeding` +* `flu chest pain` +* `flu treatment` +* `flu nausea` +* `remedies for the flu` +* `tamiflu in pregnancy` +* `side effects of tamiflu` +* `how to treat flu` +* `viral bronchitis` +* `flu how long contagious` +* `flu remedy` + +
## Response diff --git a/docs/api/wiki.md b/docs/api/wiki.md index c9850b2e2..9b04e3679 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -15,7 +15,7 @@ nav_order: 2 | **Data Source** | [Wikimedia pageviews](https://dumps.wikimedia.org/other/pagecounts-raw/) for health-related Wikipedia articles | | **Geographic Levels** | Not applicable (article-based) | | **Temporal Granularity** | Hourly, Daily, and Weekly (Epiweek) | -| **Available Articles** | [54 health-related articles](wiki_articles.html) | +| **Available Articles** | [54 health-related articles](#available-articles) | | **Reporting Cadence** | Inactive - No longer updated since 2021w11| | **Temporal Scope Start** | 2007w50 (2007-12-09) | | **License** | [CC BY-SA](https://creativecommons.org/licenses/by-sa/4.0/) | @@ -53,6 +53,115 @@ The base URL is: | `dates` | dates (see [Date Formats](date_formats.html)) | `list` of dates | | `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | +#### Valid Queries + +
+Click to expand full list of valid queries + +* `/m/0cycc` +* `influenza type a` +* `flu duration` +* `flu fever` +* `treating flu` +* `fever flu` +* `flu recovery` +* `braun thermoscan` +* `oscillococcinum` +* `treating the flu` +* `cold or flu` +* `flu versus cold` +* `flu remedies` +* `contagious flu` +* `type a influenza` +* `flu or cold` +* `duration of flu` +* `cold versus flu` +* `flu cough` +* `flu headache` +* `thermoscan` +* `influenza incubation period` +* `flu lasts` +* `length of flu` +* `flu stomach` +* `cold vs flu` +* `flu and fever` +* `getting over the flu` +* `influenza a` +* `treatment for flu` +* `flu length` +* `treatment for the flu` +* `influenza symptoms` +* `over the counter flu` +* `flu complications` +* `cold and flu symptoms` +* `influenza incubation` +* `treatment of flu` +* `human temperature` +* `low body` +* `flu contagious` +* `robitussin ac` +* `flu how long` +* `ear thermometer` +* `flu contagious period` +* `treat flu` +* `cough flu` +* `low body temperature` +* `expectorant` +* `flu and cold` +* `rapid flu` +* `flu vs. cold` +* `how to treat the flu` +* `how long does the flu last?` +* `viral pneumonia` +* `flu in kids` +* `type a flu` +* `influenza treatment` +* `fighting the flu` +* `flu relief` +* `treat the flu` +* `flu medicine` +* `dangerous fever` +* `what is influenza` +* `tussin` +* `low body temp` +* `flu care` +* `flu in infants` +* `flu dizziness` +* `feed a fever` +* `flu vs cold` +* `flu vomiting` +* `bacterial pneumonia` +* `flu activity` +* `flu chills` +* `anas barbariae` +* `flu germs` +* `tylenol cold` +* `how to get over the flu` +* `flu in children` +* `influenza a and b` +* `duration of the flu` +* `cold symptoms` +* `flu report` +* `rapid flu test` +* `flu relapse` +* `get over the flu` +* `flu during pregnancy` +* `flu recovery time` +* `cure for flu` +* `tamiflu and breastfeeding` +* `flu chest pain` +* `flu treatment` +* `flu nausea` +* `remedies for the flu` +* `tamiflu in pregnancy` +* `side effects of tamiflu` +* `how to treat flu` +* `viral bronchitis` +* `flu how long contagious` +* `flu remedy` + +
+ ### Optional @@ -223,3 +332,69 @@ print(length(res$epidata))
+ +## Available Articles + +The following health-related Wikipedia articles are available: + +
+Click to expand full list of articles + +| Article Name | +|---| +| amantadine | +| antiviral_drugs | +| avian_influenza | +| canine_influenza | +| cat_flu | +| chills | +| common_cold | +| cough | +| equine_influenza | +| fatigue_(medical) | +| fever | +| flu_season | +| gastroenteritis | +| headache | +| hemagglutinin_(influenza) | +| human_flu | +| influenza | +| influenzalike_illness | +| influenzavirus_a | +| influenzavirus_c | +| influenza_a_virus | +| influenza_a_virus_subtype_h10n7 | +| influenza_a_virus_subtype_h1n1 | +| influenza_a_virus_subtype_h1n2 | +| influenza_a_virus_subtype_h2n2 | +| influenza_a_virus_subtype_h3n2 | +| influenza_a_virus_subtype_h3n8 | +| influenza_a_virus_subtype_h5n1 | +| influenza_a_virus_subtype_h7n2 | +| influenza_a_virus_subtype_h7n3 | +| influenza_a_virus_subtype_h7n7 | +| influenza_a_virus_subtype_h7n9 | +| influenza_a_virus_subtype_h9n2 | +| influenza_b_virus | +| influenza_pandemic | +| influenza_prevention | +| influenza_vaccine | +| malaise | +| myalgia | +| nasal_congestion | +| nausea | +| neuraminidase_inhibitor | +| orthomyxoviridae | +| oseltamivir | +| paracetamol | +| rhinorrhea | +| rimantadine | +| shivering | +| sore_throat | +| swine_influenza | +| viral_neuraminidase | +| viral_pneumonia | +| vomiting | +| zanamivir | + +
diff --git a/docs/api/wiki_articles.md b/docs/api/wiki_articles.md deleted file mode 100644 index 3e9895de4..000000000 --- a/docs/api/wiki_articles.md +++ /dev/null @@ -1,77 +0,0 @@ ---- -title: Wikipedia Articles -parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 101 ---- - -# Wikipedia Articles -{: .no_toc} - -This page documents the valid Wikipedia articles accepted by the [Wikipedia Access](wiki.html) endpoint. - -## Table of contents -{: .no_toc .text-delta} - -1. TOC -{:toc} - -## Available Articles - -The following health-related Wikipedia articles are available: - -| Article Name | -|---| -| amantadine | -| antiviral_drugs | -| avian_influenza | -| canine_influenza | -| cat_flu | -| chills | -| common_cold | -| cough | -| equine_influenza | -| fatigue_(medical) | -| fever | -| flu_season | -| gastroenteritis | -| headache | -| hemagglutinin_(influenza) | -| human_flu | -| influenza | -| influenzalike_illness | -| influenzavirus_a | -| influenzavirus_c | -| influenza_a_virus | -| influenza_a_virus_subtype_h10n7 | -| influenza_a_virus_subtype_h1n1 | -| influenza_a_virus_subtype_h1n2 | -| influenza_a_virus_subtype_h2n2 | -| influenza_a_virus_subtype_h3n2 | -| influenza_a_virus_subtype_h3n8 | -| influenza_a_virus_subtype_h5n1 | -| influenza_a_virus_subtype_h7n2 | -| influenza_a_virus_subtype_h7n3 | -| influenza_a_virus_subtype_h7n7 | -| influenza_a_virus_subtype_h7n9 | -| influenza_a_virus_subtype_h9n2 | -| influenza_b_virus | -| influenza_pandemic | -| influenza_prevention | -| influenza_vaccine | -| malaise | -| myalgia | -| nasal_congestion | -| nausea | -| neuraminidase_inhibitor | -| orthomyxoviridae | -| oseltamivir | -| paracetamol | -| rhinorrhea | -| rimantadine | -| shivering | -| sore_throat | -| swine_influenza | -| viral_neuraminidase | -| viral_pneumonia | -| vomiting | -| zanamivir | From 4c22c73c631ef7e11b50e85bbf5ec03a8f69a5cc Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 9 Dec 2025 20:01:17 -0800 Subject: [PATCH 54/64] docs: correct missing elements in header for flueview_clinical, wiki, google-symptoms, safegraph, and youtube-survey --- docs/api/covidcast-signals/google-symptoms.md | 9 +- docs/api/covidcast-signals/safegraph.md | 16 +- docs/api/covidcast-signals/youtube-survey.md | 5 +- docs/api/fluview_clinical.md | 2 +- docs/api/wiki.md | 236 +++++------------- 5 files changed, 79 insertions(+), 189 deletions(-) diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index 37b6ad967..9bf42dc7a 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -14,8 +14,9 @@ nav_order: 2 | **Data Source** | Google | | **Geographic Levels** | National, U.S. HHS Region, State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md)) | | **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | -| **Date of last data revision:** | March 14, 2025 (see [data revision docs](#changelog)) | -| **Temporal Scope Start** | 2020-02-13, with some variation depending on geographic area| +| **Reporting Cadence** | Inactive - No longer updated after November 16th, 2025 | +| **Date of last data revision:** | March 14th, 2025 (see [data revision docs](#changelog)) | +| **Temporal Scope Start** | February 13th, 2020, with some variation depending on geographic area| | **License** | [Google Terms of Service](https://policies.google.com/terms) | ## Changelog @@ -23,10 +24,10 @@ nav_order: 2
Click to expand -### March 14, 2025 +### March 14th, 2025 Google added earlier dates starting from 2017-08-15 and also fixed a gap of county-level data from November 14 2022 through February 20, 2023. -### February 14, 2025 +### February 14th, 2025 We added a new signal s07_raw_search and s07_smoothed_search.
diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md index b1cc56757..6e17a9595 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -14,7 +14,7 @@ nav_order: 2 | **Data Source** | SafeGraph | | **Geographic Levels** | State, County, Hospital Referral Region (HRR), Metropolitan Statistical Area (MSA) (see [geography coding docs](../covidcast_geography.md))| | **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | -| **Temporal Scope Start** | 2019-01-01 | +| **Temporal Scope Start** | January 1st, 2019 | | **License** | [CC BY](../covidcast_licensing.md#creative-commons-attribution) | This data source uses data reported by [SafeGraph](https://www.safegraph.com/) @@ -31,7 +31,7 @@ surface signals from two such datasets. ## SafeGraph Social Distancing Metrics | Attribute | Details | -| **Date of last data revision:** | November 3, 2020 (see [data revision docs](#changelog-social-distancing-metrics)) | +| **Date of last data revision:** | November 3rd, 2020 (see [data revision docs](#changelog-social-distancing-metrics)) | | **Reporting Cadence** | Inactive - No longer updated after April 19th, 2021. | ### Changelog (Social Distancing Metrics) @@ -41,11 +41,11 @@ surface signals from two such datasets. See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. -#### April 19, 2021 +#### April 19th, 2021 The Safegraph social distancing metrics are no longer being updated. Weekly patterns are still available. -#### November 3, 2020 +#### November 3rd, 2020 We went from a custom geo mapping file (for aggregating from county->state) to a central geo file based on rigorously sourced US census data. @@ -99,11 +99,9 @@ additional day for SafeGraph's data to be ingested into the COVIDcast API. ## SafeGraph Weekly Patterns - - | Attribute | Details | | **Date of last data revision:** | Never (see [data revision docs](#changelog-weekly-patterns)) | -| **Reporting Cadence** | Inactive - No longer updated after July 15th, 2022. | +| **Reporting Cadence** | Inactive - No longer updated after May 5th, 2022 | ### Changelog (Weekly Patterns) @@ -112,10 +110,10 @@ additional day for SafeGraph's data to be ingested into the COVIDcast API. See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals. -#### July 15, 2022 +#### July 15th, 2022 The Safegraph Weekly Patterns dataset is no longer updated. -#### November 3, 2020 +#### November 3rd, 2020 We went from a custom geo mapping file (for aggregating from county->state) to a central geo file based on rigorously sourced US census data. diff --git a/docs/api/covidcast-signals/youtube-survey.md b/docs/api/covidcast-signals/youtube-survey.md index 22c5e02fa..cc0fa0d7e 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -16,11 +16,10 @@ nav_order: 2 | **Data Source** | Google/Delphi | | **Geographic Levels** | State (see [geography coding docs](../covidcast_geography.md)) | | **Temporal Granularity** | Daily (see [date format docs](../covidcast_times.md)) | -| **Reporting Cadence** | Inactive - No longer updated | +| **Reporting Cadence** | Inactive - No longer updated after June 22nd, 2020 | | **Date of last data revision:** | Never (see [data revision docs](#changelog)) | | **License** | [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial) | - - +| **Temporal Scope Start** | April 21st, 2020 | ## Changelog diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index 96b0f84bf..082d9c2ed 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -15,7 +15,7 @@ nav_order: 1 | **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | | **Geographic Levels** | National, HHS regions, states, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | | **Temporal Granularity** | Weekly (Epiweek) | -| **Reporting Cadence** | Weekly (typically Fridays) | +| **Reporting Cadence** | Weekly (typically Fridays) | | **Temporal Scope Start** | 2016w40 | | **License** | [Publicly Accessible US Government](https://www.usa.gov/government-works) | diff --git a/docs/api/wiki.md b/docs/api/wiki.md index 9b04e3679..b77342be9 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -17,7 +17,7 @@ nav_order: 2 | **Temporal Granularity** | Hourly, Daily, and Weekly (Epiweek) | | **Available Articles** | [54 health-related articles](#available-articles) | | **Reporting Cadence** | Inactive - No longer updated since 2021w11| -| **Temporal Scope Start** | 2007w50 (2007-12-09) | +| **Temporal Scope Start** | 2007w50 (December 9th, 2007) | | **License** | [CC BY-SA](https://creativecommons.org/licenses/by-sa/4.0/) | @@ -48,121 +48,79 @@ The base URL is: | Parameter | Description | Type | | --- | --- | --- | -| `articles` | articles | list of [articles](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/articles.md) | +| `articles` | articles | list of [articles](#available-articles) | | `language` | language (currently `en`, `es`, and `pt` supported) | string | | `dates` | dates (see [Date Formats](date_formats.html)) | `list` of dates | | `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks | -#### Valid Queries +#### Available Articles + +The following health-related Wikipedia articles are available:
-Click to expand full list of valid queries - -* `/m/0cycc` -* `influenza type a` -* `flu duration` -* `flu fever` -* `treating flu` -* `fever flu` -* `flu recovery` -* `braun thermoscan` -* `oscillococcinum` -* `treating the flu` -* `cold or flu` -* `flu versus cold` -* `flu remedies` -* `contagious flu` -* `type a influenza` -* `flu or cold` -* `duration of flu` -* `cold versus flu` -* `flu cough` -* `flu headache` -* `thermoscan` -* `influenza incubation period` -* `flu lasts` -* `length of flu` -* `flu stomach` -* `cold vs flu` -* `flu and fever` -* `getting over the flu` -* `influenza a` -* `treatment for flu` -* `flu length` -* `treatment for the flu` -* `influenza symptoms` -* `over the counter flu` -* `flu complications` -* `cold and flu symptoms` -* `influenza incubation` -* `treatment of flu` -* `human temperature` -* `low body` -* `flu contagious` -* `robitussin ac` -* `flu how long` -* `ear thermometer` -* `flu contagious period` -* `treat flu` -* `cough flu` -* `low body temperature` -* `expectorant` -* `flu and cold` -* `rapid flu` -* `flu vs. cold` -* `how to treat the flu` -* `how long does the flu last?` -* `viral pneumonia` -* `flu in kids` -* `type a flu` -* `influenza treatment` -* `fighting the flu` -* `flu relief` -* `treat the flu` -* `flu medicine` -* `dangerous fever` -* `what is influenza` -* `tussin` -* `low body temp` -* `flu care` -* `flu in infants` -* `flu dizziness` -* `feed a fever` -* `flu vs cold` -* `flu vomiting` -* `bacterial pneumonia` -* `flu activity` -* `flu chills` -* `anas barbariae` -* `flu germs` -* `tylenol cold` -* `how to get over the flu` -* `flu in children` -* `influenza a and b` -* `duration of the flu` -* `cold symptoms` -* `flu report` -* `rapid flu test` -* `flu relapse` -* `get over the flu` -* `flu during pregnancy` -* `flu recovery time` -* `cure for flu` -* `tamiflu and breastfeeding` -* `flu chest pain` -* `flu treatment` -* `flu nausea` -* `remedies for the flu` -* `tamiflu in pregnancy` -* `side effects of tamiflu` -* `how to treat flu` -* `viral bronchitis` -* `flu how long contagious` -* `flu remedy` +Click to expand full list of articles + +| Article Name | +|---| +| amantadine | +| antiviral_drugs | +| avian_influenza | +| canine_influenza | +| cat_flu | +| chills | +| common_cold | +| cough | +| equine_influenza | +| fatigue_(medical) | +| fever | +| flu_season | +| gastroenteritis | +| headache | +| hemagglutinin_(influenza) | +| human_flu | +| influenza | +| influenzalike_illness | +| influenzavirus_a | +| influenzavirus_c | +| influenza_a_virus | +| influenza_a_virus_subtype_h10n7 | +| influenza_a_virus_subtype_h1n1 | +| influenza_a_virus_subtype_h1n2 | +| influenza_a_virus_subtype_h2n2 | +| influenza_a_virus_subtype_h3n2 | +| influenza_a_virus_subtype_h3n8 | +| influenza_a_virus_subtype_h5n1 | +| influenza_a_virus_subtype_h7n2 | +| influenza_a_virus_subtype_h7n3 | +| influenza_a_virus_subtype_h7n7 | +| influenza_a_virus_subtype_h7n9 | +| influenza_a_virus_subtype_h9n2 | +| influenza_b_virus | +| influenza_pandemic | +| influenza_prevention | +| influenza_vaccine | +| malaise | +| myalgia | +| nasal_congestion | +| nausea | +| neuraminidase_inhibitor | +| orthomyxoviridae | +| oseltamivir | +| paracetamol | +| rhinorrhea | +| rimantadine | +| shivering | +| sore_throat | +| swine_influenza | +| viral_neuraminidase | +| viral_pneumonia | +| vomiting | +| zanamivir |
+ ### Optional | Parameter | Description | Type | @@ -332,69 +290,3 @@ print(length(res$epidata))
- -## Available Articles - -The following health-related Wikipedia articles are available: - -
-Click to expand full list of articles - -| Article Name | -|---| -| amantadine | -| antiviral_drugs | -| avian_influenza | -| canine_influenza | -| cat_flu | -| chills | -| common_cold | -| cough | -| equine_influenza | -| fatigue_(medical) | -| fever | -| flu_season | -| gastroenteritis | -| headache | -| hemagglutinin_(influenza) | -| human_flu | -| influenza | -| influenzalike_illness | -| influenzavirus_a | -| influenzavirus_c | -| influenza_a_virus | -| influenza_a_virus_subtype_h10n7 | -| influenza_a_virus_subtype_h1n1 | -| influenza_a_virus_subtype_h1n2 | -| influenza_a_virus_subtype_h2n2 | -| influenza_a_virus_subtype_h3n2 | -| influenza_a_virus_subtype_h3n8 | -| influenza_a_virus_subtype_h5n1 | -| influenza_a_virus_subtype_h7n2 | -| influenza_a_virus_subtype_h7n3 | -| influenza_a_virus_subtype_h7n7 | -| influenza_a_virus_subtype_h7n9 | -| influenza_a_virus_subtype_h9n2 | -| influenza_b_virus | -| influenza_pandemic | -| influenza_prevention | -| influenza_vaccine | -| malaise | -| myalgia | -| nasal_congestion | -| nausea | -| neuraminidase_inhibitor | -| orthomyxoviridae | -| oseltamivir | -| paracetamol | -| rhinorrhea | -| rimantadine | -| shivering | -| sore_throat | -| swine_influenza | -| viral_neuraminidase | -| viral_pneumonia | -| vomiting | -| zanamivir | - -
From 637e83003b6f8987216ab570e4b6cc354d750b12 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 9 Dec 2025 20:53:29 -0800 Subject: [PATCH 55/64] docs: add endpoint details for flueview --- docs/api/fluview.md | 31 ++++++++++++++++++++++++++++++- docs/api/geographic_codes.md | 16 ++++++++++++++++ 2 files changed, 46 insertions(+), 1 deletion(-) diff --git a/docs/api/fluview.md b/docs/api/fluview.md index 6df453000..11b7aadb8 100644 --- a/docs/api/fluview.md +++ b/docs/api/fluview.md @@ -13,7 +13,7 @@ nav_order: 1 | :--- | :--- | | **Source Name** | `fluview` | | **Data Source** | [United States Centers for Disease Control and Prevention (CDC)](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) | -| **Geographic Levels** | National, states, HHS regions, and Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) | +| **Geographic Levels** | National, states, HHS regions, Census divisions (see [Geographic Codes](geographic_codes.html#us-regions-and-states)), and cities (see [FluView Cities](geographic_codes.html#fluview-cities)) | | **Temporal Granularity** | Weekly (Epiweek) | | **Reporting Cadence** | Weekly (typically Fridays) | | **Temporal Scope Start** | 1997w40 | @@ -35,6 +35,35 @@ General topics not specific to any particular endpoint are discussed in the 1. TOC {:toc} +## Estimation + +### Definition of ILI +For this system, ILI is defined as fever (temperature of 100°F [37.8°C] or greater) and a cough and/or a sore throat without a known cause other than influenza. + +### Weighted vs. Unweighted ILI +The `fluview` endpoint provides two percentage metrics: `ili` (unweighted) and `wili` (weighted). + +* **Unweighted (`ili`):** Calculated simply as the number of ILI cases divided by the total number of patients seen: + + $$ILI = 100 \cdot \frac{\text{num\_ili}}{\text{num\_patients}}$$ + +* **Weighted (`wili`):** To produce a representative estimate for larger regions (like National or HHS Regions), the CDC weights the state-level data by state population. This corrects for the fact that some states may have higher provider participation rates than others relative to their actual population. + + $$wILI_{region} = \sum_{s \in region} \left( \%ILI_s \times \frac{Pop_s}{Pop_{region}} \right)$$ + +### Imputation +State-level data was not publicly available from the CDC prior to the 2010-2011 flu season (2010w40). For dates prior to this, and for occasional missing reports, Delphi uses a sensor fusion approach (OLS regression) to impute state-level values based on the available regional data. + +Private imputed data may require specific authorization via the `auth` parameter. + +## Lag and Backfill + +The data is preliminary and subject to revision. Participating providers may report data late, or correct previously reported data. The `issues` and `lag` parameters in the API allow you to access historical versions of the data as they were reported on specific dates. + +## Limitations + +ILINet is a voluntary system. While it covers all states, the coverage within a state may not be perfectly representative of the entire population. Also, ILI is a syndromic definition, not a laboratory diagnosis. It captures patients with flu-like symptoms, which can be caused by other respiratory pathogens (including SARS-CoV-2 and RSV). + # The API The base URL is: diff --git a/docs/api/geographic_codes.md b/docs/api/geographic_codes.md index 9273e18b5..69c324fab 100644 --- a/docs/api/geographic_codes.md +++ b/docs/api/geographic_codes.md @@ -449,3 +449,19 @@ Geographic codes used by the [KCDC ILI](kcdc_ili.html) endpoint. | ROK | Republic of Korea | +## FluView Cities + +Specific cities used by the [FluView](fluview.html) endpoint. + +| City | Code | +|---|---| +| Chicago | ord | +| Los Angeles | lax | +| New York City | jfk | + +### Note on New York + +In the CDC FluView system, New York State and New York City are often reported separately. +* `ny_minus_jfk` represents New York State **excluding** NYC. +* `jfk` represents New York City. +* `ny` represents the entire state (the sum of the two). From b21ad768c3c9f8a75ff4d8bba484997d2f1c851b Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Tue, 9 Dec 2025 21:16:37 -0800 Subject: [PATCH 56/64] docs: reorder pages and collapse inactive sources and endpoints under the inactive page. --- docs/api/01meta.md | 5 ++--- docs/api/README.md | 2 +- docs/api/cdc.md | 5 ++--- docs/api/client_libraries.md | 2 +- docs/api/covid_hosp.md | 5 ++--- docs/api/covid_hosp_facility.md | 5 ++--- docs/api/covid_hosp_facility_lookup.md | 5 ++--- docs/api/covidcast-signals/chng.md | 5 ++--- docs/api/covidcast-signals/covid-act-now.md | 5 ++--- .../covid-trends-and-impact-survey.md | 5 ++--- docs/api/covidcast-signals/dsew-cpr.md | 5 ++--- docs/api/covidcast-signals/ght.md | 7 +++---- docs/api/covidcast-signals/google-survey.md | 5 ++--- docs/api/covidcast-signals/google-symptoms.md | 5 ++--- docs/api/covidcast-signals/hhs.md | 5 ++--- docs/api/covidcast-signals/inactive.md | 12 ++++++++++++ docs/api/covidcast-signals/indicator-combination.md | 5 ++--- docs/api/covidcast-signals/jhu-csse.md | 5 ++--- docs/api/covidcast-signals/safegraph.md | 5 ++--- docs/api/covidcast-signals/usa-facts.md | 5 ++--- docs/api/covidcast-signals/youtube-survey.md | 5 ++--- docs/api/covidcast.md | 2 +- docs/api/covidcast_changelog.md | 2 +- docs/api/covidcast_geography.md | 2 +- docs/api/covidcast_times.md | 2 +- docs/api/date_formats.md | 2 +- docs/api/delphi.md | 5 ++--- docs/api/dengue_digital_surveillance.md | 5 ++--- docs/api/dengue_nowcast.md | 5 ++--- docs/api/digital_surveillance_sensors.md | 5 ++--- docs/api/ecdc_ili.md | 5 ++--- docs/api/flusurv.md | 2 +- docs/api/fluview_clinical.md | 2 +- docs/api/geographic_codes.md | 2 +- docs/api/gft.md | 5 ++--- docs/api/ght.md | 5 ++--- docs/api/glossary.md | 2 +- docs/api/ili_nearby_nowcast.md | 5 ++--- docs/api/inactive_other.md | 12 ++++++++++++ docs/api/kcdc_ili.md | 5 ++--- docs/api/nidss_dengue.md | 5 ++--- docs/api/nidss_flu.md | 5 ++--- docs/api/norostat.md | 5 ++--- docs/api/norostat_meta.md | 5 ++--- docs/api/paho_dengue.md | 5 ++--- docs/api/quidel.md | 5 ++--- docs/api/twitter.md | 5 ++--- docs/api/wiki.md | 5 ++--- 48 files changed, 106 insertions(+), 117 deletions(-) create mode 100644 docs/api/covidcast-signals/inactive.md create mode 100644 docs/api/inactive_other.md diff --git a/docs/api/01meta.md b/docs/api/01meta.md index 7e20ca30e..a61f31a8f 100644 --- a/docs/api/01meta.md +++ b/docs/api/01meta.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals 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 --- diff --git a/docs/api/README.md b/docs/api/README.md index b5e75620d..73a57026d 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -1,7 +1,7 @@ --- title: Other Endpoints (COVID-19 and Other Diseases) has_children: true -nav_order: 3 +nav_order: 2 --- # Other Endpoints (COVID-19 and Other Diseases) diff --git a/docs/api/cdc.md b/docs/api/cdc.md index 9e7a0e57b..177211b60 100644 --- a/docs/api/cdc.md +++ b/docs/api/cdc.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive CDC -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # CDC diff --git a/docs/api/client_libraries.md b/docs/api/client_libraries.md index 8b1ff5760..b7d941206 100644 --- a/docs/api/client_libraries.md +++ b/docs/api/client_libraries.md @@ -1,6 +1,6 @@ --- title: API Clients -nav_order: 6 +nav_order: 3 --- # Getting Started with R and Python diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md index 70fe0239c..107b044cb 100644 --- a/docs/api/covid_hosp.md +++ b/docs/api/covid_hosp.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive COVID-19 Reported Patient Impact and Hospital Capacity by State Timeseries -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # COVID-19 Hospitalization by State diff --git a/docs/api/covid_hosp_facility.md b/docs/api/covid_hosp_facility.md index 17fe7664c..bc9c0a342 100644 --- a/docs/api/covid_hosp_facility.md +++ b/docs/api/covid_hosp_facility.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive COVID-19 Reported Patient Impact and Hospital Capacity by Facility -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # COVID-19 Hospitalization by Facility diff --git a/docs/api/covid_hosp_facility_lookup.md b/docs/api/covid_hosp_facility_lookup.md index 50c74ac5f..b0424ad67 100644 --- a/docs/api/covid_hosp_facility_lookup.md +++ b/docs/api/covid_hosp_facility_lookup.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive COVID-19 Reported Patient Impact and Hospital Capacity - Facility lookup -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # COVID-19 Hospitalization: Facility Lookup diff --git a/docs/api/covidcast-signals/chng.md b/docs/api/covidcast-signals/chng.md index 107b655f9..b5e7561f1 100644 --- a/docs/api/covidcast-signals/chng.md +++ b/docs/api/covidcast-signals/chng.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive Change Healthcare -parent: Data Sources and Signals -grand_parent: Main Endpoint (COVIDcast) -nav_order: 2 --- # Change Healthcare diff --git a/docs/api/covidcast-signals/covid-act-now.md b/docs/api/covidcast-signals/covid-act-now.md index 56dbbe5f6..d6420627e 100644 --- a/docs/api/covidcast-signals/covid-act-now.md +++ b/docs/api/covidcast-signals/covid-act-now.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive COVID Act Now -parent: Data Sources and Signals -grand_parent: Main Endpoint (COVIDcast) -nav_order: 2 --- # COVID Act Now (CAN) diff --git a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md index 8e88645c8..69f354de9 100644 --- a/docs/api/covidcast-signals/covid-trends-and-impact-survey.md +++ b/docs/api/covidcast-signals/covid-trends-and-impact-survey.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals 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 --- diff --git a/docs/api/covidcast-signals/dsew-cpr.md b/docs/api/covidcast-signals/dsew-cpr.md index 4ad7d3a0a..fa6887581 100644 --- a/docs/api/covidcast-signals/dsew-cpr.md +++ b/docs/api/covidcast-signals/dsew-cpr.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive Data Strategy and Execution Workgroup Community Profile Report -parent: Data Sources and Signals -grand_parent: Main Endpoint (COVIDcast) -nav_order: 2 --- # Data Strategy and Execution Workgroup Community Profile Report (CPR) diff --git a/docs/api/covidcast-signals/ght.md b/docs/api/covidcast-signals/ght.md index 9caf23222..612434016 100644 --- a/docs/api/covidcast-signals/ght.md +++ b/docs/api/covidcast-signals/ght.md @@ -1,8 +1,7 @@ --- -title: inactive Google Health Trends -parent: Data Sources and Signals -grand_parent: Main Endpoint (COVIDcast) -nav_order: 2 +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals +title: inactive (COVIDcast) Google Health Trends --- # Google Health Trends diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md index 322d7be01..701182447 100644 --- a/docs/api/covidcast-signals/google-survey.md +++ b/docs/api/covidcast-signals/google-survey.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive Google Symptom Surveys -parent: Data Sources and Signals -grand_parent: Main Endpoint (COVIDcast) -nav_order: 2 --- # Google Symptom Surveys diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index 9bf42dc7a..d5926a7a5 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive Google Symptom Search Trends -parent: Data Sources and Signals -grand_parent: Main Endpoint (COVIDcast) -nav_order: 2 --- # Google Symptoms diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index e5ef3a645..b2868b324 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive HHS Hospitalizations from NHSN -parent: Data Sources and Signals -grand_parent: Main Endpoint (COVIDcast) -nav_order: 2 --- # Department of Health & Human Services Hospitalizations diff --git a/docs/api/covidcast-signals/inactive.md b/docs/api/covidcast-signals/inactive.md new file mode 100644 index 000000000..bebbb83ff --- /dev/null +++ b/docs/api/covidcast-signals/inactive.md @@ -0,0 +1,12 @@ +--- +title: Inactive Sources (COVIDcast) +parent: Data Sources and Signals +grand_parent: Main Endpoint (COVIDcast) +nav_order: 99 +has_children: true +--- + +# Inactive COVIDcast Sources +{: .no_toc} + +These COVIDcast data sources and signals are no longer actively updated. diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index 620cc1df8..baeafe22b 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive Indicator Combination -parent: Data Sources and Signals -grand_parent: Main Endpoint (COVIDcast) -nav_order: 2 --- # Indicator Combination diff --git a/docs/api/covidcast-signals/jhu-csse.md b/docs/api/covidcast-signals/jhu-csse.md index 8394ef7ac..c4d572f98 100644 --- a/docs/api/covidcast-signals/jhu-csse.md +++ b/docs/api/covidcast-signals/jhu-csse.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive JHU Cases and Deaths -parent: Data Sources and Signals -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 6e17a9595..f8369f91a 100644 --- a/docs/api/covidcast-signals/safegraph.md +++ b/docs/api/covidcast-signals/safegraph.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive SafeGraph -parent: Data Sources and Signals -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 84decf9ce..f7763c93f 100644 --- a/docs/api/covidcast-signals/usa-facts.md +++ b/docs/api/covidcast-signals/usa-facts.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive USAFacts Cases and Deaths -parent: Data Sources and Signals -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 cc0fa0d7e..27c86fd63 100644 --- a/docs/api/covidcast-signals/youtube-survey.md +++ b/docs/api/covidcast-signals/youtube-survey.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (COVIDcast) +grand_parent: Data Sources and Signals title: inactive Youtube Survey -parent: Data Sources and Signals -grand_parent: Main Endpoint (COVIDcast) -nav_order: 2 --- [//]: # (code at https://github.com/cmu-delphi/covid-19/tree/deeb4dc1e9a30622b415361ef6b99198e77d2a94/youtube) diff --git a/docs/api/covidcast.md b/docs/api/covidcast.md index fa46dffda..8415adfb8 100644 --- a/docs/api/covidcast.md +++ b/docs/api/covidcast.md @@ -1,7 +1,7 @@ --- title: Main Endpoint (COVIDcast) has_children: true -nav_order: 2 +nav_order: 1 --- # Main Epidata API diff --git a/docs/api/covidcast_changelog.md b/docs/api/covidcast_changelog.md index 204cd3553..97ce40e81 100644 --- a/docs/api/covidcast_changelog.md +++ b/docs/api/covidcast_changelog.md @@ -1,7 +1,7 @@ --- title: Signal Changelog parent: Main Endpoint (COVIDcast) -nav_order: 8 +nav_order: 92 --- # COVIDcast Signal Changes diff --git a/docs/api/covidcast_geography.md b/docs/api/covidcast_geography.md index a88b17cd3..06e93f42b 100644 --- a/docs/api/covidcast_geography.md +++ b/docs/api/covidcast_geography.md @@ -1,7 +1,7 @@ --- title: Geographic Coding parent: Main Endpoint (COVIDcast) -nav_order: 5 +nav_order: 90 --- # COVIDcast Geographic Coding diff --git a/docs/api/covidcast_times.md b/docs/api/covidcast_times.md index caabfb39a..cd6a38d37 100644 --- a/docs/api/covidcast_times.md +++ b/docs/api/covidcast_times.md @@ -1,7 +1,7 @@ --- title: Date Coding and Revisions parent: Main Endpoint (COVIDcast) -nav_order: 6 +nav_order: 91 --- # Date Coding and Revisions diff --git a/docs/api/date_formats.md b/docs/api/date_formats.md index 98569e036..414d2f6dc 100644 --- a/docs/api/date_formats.md +++ b/docs/api/date_formats.md @@ -1,7 +1,7 @@ --- title: Date Formats parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 101 +nav_order: 901 --- # Date Formats diff --git a/docs/api/delphi.md b/docs/api/delphi.md index 6b06d820a..4fa6fd594 100644 --- a/docs/api/delphi.md +++ b/docs/api/delphi.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive Delphi Forecasts -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # Delphi Forecasts diff --git a/docs/api/dengue_digital_surveillance.md b/docs/api/dengue_digital_surveillance.md index fc6bc7223..76cc303f2 100644 --- a/docs/api/dengue_digital_surveillance.md +++ b/docs/api/dengue_digital_surveillance.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals 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 --- diff --git a/docs/api/dengue_nowcast.md b/docs/api/dengue_nowcast.md index 511fdd6f2..9f269f99b 100644 --- a/docs/api/dengue_nowcast.md +++ b/docs/api/dengue_nowcast.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive Dengue Nowcast -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # Delphi's Dengue Nowcast diff --git a/docs/api/digital_surveillance_sensors.md b/docs/api/digital_surveillance_sensors.md index 96a32c542..be0e74823 100644 --- a/docs/api/digital_surveillance_sensors.md +++ b/docs/api/digital_surveillance_sensors.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals 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 --- diff --git a/docs/api/ecdc_ili.md b/docs/api/ecdc_ili.md index d641a67be..27b54eccf 100644 --- a/docs/api/ecdc_ili.md +++ b/docs/api/ecdc_ili.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive ECDC ILI -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # ECDC ILI diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md index eb43983d9..eacbefe79 100644 --- a/docs/api/flusurv.md +++ b/docs/api/flusurv.md @@ -2,7 +2,7 @@ title: Flusurv parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 1 +nav_order: 3 --- # FluSurv diff --git a/docs/api/fluview_clinical.md b/docs/api/fluview_clinical.md index 082d9c2ed..e42c23f98 100644 --- a/docs/api/fluview_clinical.md +++ b/docs/api/fluview_clinical.md @@ -2,7 +2,7 @@ title: FluView Clinical parent: Data Sources and Signals grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 1 +nav_order: 2 --- # FluView Clinical diff --git a/docs/api/geographic_codes.md b/docs/api/geographic_codes.md index 69c324fab..fe2fcaecc 100644 --- a/docs/api/geographic_codes.md +++ b/docs/api/geographic_codes.md @@ -1,7 +1,7 @@ --- title: Geographic Codes parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 100 +nav_order: 900 --- # Geographic Codes diff --git a/docs/api/gft.md b/docs/api/gft.md index e5046f550..d8abbc695 100644 --- a/docs/api/gft.md +++ b/docs/api/gft.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive Google Flu Trends -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # Google Flu Trends diff --git a/docs/api/ght.md b/docs/api/ght.md index ce199f7ce..0d49b50f6 100644 --- a/docs/api/ght.md +++ b/docs/api/ght.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive Google Health Trends -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # Google Health Trends diff --git a/docs/api/glossary.md b/docs/api/glossary.md index 206c6f011..84f9898a2 100644 --- a/docs/api/glossary.md +++ b/docs/api/glossary.md @@ -1,6 +1,6 @@ --- title: Glossary (link to Google Doc) -nav_order: 7 +nav_order: 4 --- # Glossary diff --git a/docs/api/ili_nearby_nowcast.md b/docs/api/ili_nearby_nowcast.md index 25781fab4..01d11e543 100644 --- a/docs/api/ili_nearby_nowcast.md +++ b/docs/api/ili_nearby_nowcast.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals 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 --- diff --git a/docs/api/inactive_other.md b/docs/api/inactive_other.md new file mode 100644 index 000000000..3b9361088 --- /dev/null +++ b/docs/api/inactive_other.md @@ -0,0 +1,12 @@ +--- +title: Inactive Sources (Other) +parent: Data Sources and Signals +grand_parent: Other Endpoints (COVID-19 and Other Diseases) +nav_order: 99 +has_children: true +--- + +# Inactive Other Sources +{: .no_toc} + +These Other Endpoint data sources are no longer actively updated. diff --git a/docs/api/kcdc_ili.md b/docs/api/kcdc_ili.md index d3a7eab28..52192a4c9 100644 --- a/docs/api/kcdc_ili.md +++ b/docs/api/kcdc_ili.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive KCDC ILI -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # KCDC ILI diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md index 34264d8cb..5fa43f6fc 100644 --- a/docs/api/nidss_dengue.md +++ b/docs/api/nidss_dengue.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive NIDSS Dengue -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # NIDSS Dengue diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md index 6d19e7ebe..b693c9aea 100644 --- a/docs/api/nidss_flu.md +++ b/docs/api/nidss_flu.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive NIDSS Flu -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # NIDSS Flu diff --git a/docs/api/norostat.md b/docs/api/norostat.md index 4d7fcb8f5..53e9e9164 100644 --- a/docs/api/norostat.md +++ b/docs/api/norostat.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive NoroSTAT -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # NoroSTAT diff --git a/docs/api/norostat_meta.md b/docs/api/norostat_meta.md index d4e994c08..5f43349ef 100644 --- a/docs/api/norostat_meta.md +++ b/docs/api/norostat_meta.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals 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 --- diff --git a/docs/api/paho_dengue.md b/docs/api/paho_dengue.md index 00db913c9..ef2bf62cc 100644 --- a/docs/api/paho_dengue.md +++ b/docs/api/paho_dengue.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive PAHO Dengue -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # PAHO Dengue diff --git a/docs/api/quidel.md b/docs/api/quidel.md index b67f9e791..590f2232d 100644 --- a/docs/api/quidel.md +++ b/docs/api/quidel.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive Quidel -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # Quidel diff --git a/docs/api/twitter.md b/docs/api/twitter.md index ed92f9cec..65c026422 100644 --- a/docs/api/twitter.md +++ b/docs/api/twitter.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive Twitter Stream -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # Twitter Stream diff --git a/docs/api/wiki.md b/docs/api/wiki.md index b77342be9..dfb64ecab 100644 --- a/docs/api/wiki.md +++ b/docs/api/wiki.md @@ -1,8 +1,7 @@ --- +parent: Inactive Sources (Other) +grand_parent: Data Sources and Signals title: inactive Wikipedia Access -parent: Data Sources and Signals -grand_parent: Other Endpoints (COVID-19 and Other Diseases) -nav_order: 2 --- # Wikipedia Access From 0df018e122c851caece4484d7d1c262a64d060be Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Wed, 10 Dec 2025 00:10:37 -0800 Subject: [PATCH 57/64] docs: adjust sidebar and content width --- docs/_sass/color_schemes/delphi.scss | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/_sass/color_schemes/delphi.scss b/docs/_sass/color_schemes/delphi.scss index db2b1f832..9fbada4c4 100644 --- a/docs/_sass/color_schemes/delphi.scss +++ b/docs/_sass/color_schemes/delphi.scss @@ -24,4 +24,12 @@ $nav-child-link-color: $fg; // Code $code-background-color: #f6f8fa; -$code-text-color: $fg; \ No newline at end of file +$code-text-color: $fg; + +// Layout Configuration +// Sidebar width +$nav-width: 22rem; +$nav-width-md: 22rem; + +// Content area width +$content-width: 100rem; \ No newline at end of file From 9b2896e08ba0611ffaaf56760f8bea3a3b0b6109 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Wed, 10 Dec 2025 00:30:37 -0800 Subject: [PATCH 58/64] docs: update the signals table for HHS with the earliest date for 7-day average signals --- docs/api/covidcast-signals/hhs.md | 32 +++++++++++++++++-------------- 1 file changed, 18 insertions(+), 14 deletions(-) diff --git a/docs/api/covidcast-signals/hhs.md b/docs/api/covidcast-signals/hhs.md index b2868b324..a7d336a43 100644 --- a/docs/api/covidcast-signals/hhs.md +++ b/docs/api/covidcast-signals/hhs.md @@ -49,20 +49,24 @@ adult and pediatric COVID-19 hospital admissions. This sum is used as the We also include influenza hospital admissions. -| Signal and 7-day average signal | Description | -|---|---| -| `confirmed_admissions_covid_1d` and `confirmed_admissions_covid_1d_7dav` | Sum of adult and pediatric confirmed COVID-19 hospital admissions occurring each day.
**Earliest date available:** 2019-12-31 | -| `confirmed_admissions_covid_1d_prop` and `confirmed_admissions_covid_1d_prop_7dav` | Sum of adult and pediatric confirmed COVID-19 hospital admissions occurring each day, per 100,000 population.
**Earliest date available:** 2019-12-31 | -| `sum_confirmed_suspected_admissions_covid_1d` and `sum_confirmed_suspected_admissions_covid_1d_7dav` | Sum of adult and pediatric confirmed and suspected COVID-19 hospital admissions occurring each day.
**Earliest date available:** 2019-12-31 | -| `sum_confirmed_suspected_admissions_covid_1d_prop` and
`sum_confirmed_suspected_admissions_covid_1d_prop_7dav` | Sum of adult and pediatric confirmed and suspected COVID-19 hospital admissions occurring each day, per 100,000 population.
**Earliest date available:** 2019-12-31 | -| `confirmed_admissions_influenza_1d` and `confirmed_admissions_influenza_1d_7dav` | All confirmed influenza hospital admissions occurring each day. We made this signal available November 1, 2021.
**Earliest issue available:** 2021-09-20
**Earliest date available:** 2020-01-02 | -| `confirmed_admissions_influenza_1d_prop` and `confirmed_admissions_influenza_1d_prop_7dav` | All confirmed influenza hospital admissions occurring each day, per 100,000 population. We made this signal available November 1, 2021.
**Earliest issue available:** 2021-09-20
**Earliest date available:** 2020-01-02 | - -*for all the above signals & 7-day average signals, their geography is state, and resolution is 1 day. - -The 7-day average signals are computed by Delphi by calculating -moving averages of the preceding 7 days, so e.g. the signal for June 7 is the -average of the underlying data for June 1 through 7, inclusive. +Each metric below is available in four variants: +1. **Raw Count:** `_1d` +2. **Smoothed (7-day average):** `_1d_7dav` +3. **Population Proportion (per 100k):** `_1d_prop` +4. **Smoothed Proportion:** `_1d_prop_7dav` + +| Metric | Base Signal Name | Description | +| :--- | :--- | :--- | +| **Confirmed COVID-19** | `confirmed_admissions_covid` | **Sum of Adult + Pediatric.** Confirmed admissions only.

**Earliest Dates:**
• `_1d` (Daily): **2019-12-31**
• `_7dav` (7-Day Avg): **2020-01-06** | +| **Suspected + Confirmed** | `sum_confirmed_suspected_admissions_covid` | **Sum of Adult + Pediatric.** Combined count of confirmed and suspected cases.

**Earliest Dates:**
• `_1d` (Daily): **2019-12-31**
• `_7dav` (7-Day Avg): **2020-01-06** | +| **Influenza** | `confirmed_admissions_influenza` | All confirmed influenza hospital admissions.

**Earliest Dates:**
• `_1d` (Daily): **2020-01-02**
• `_7dav` (7-Day Avg): **2020-01-08** | + + +> **Note** +> * For all the above signals & 7-day average signals, their geography is state, and resolution is 1 day. +> * The 7-day average signals are computed by Delphi by calculating moving averages of the preceding 7 days, so e.g. the signal for June 7 is the average of the underlying data for June 1 through 7, inclusive. +{: .note } + ## Table of contents {: .no_toc .text-delta} From da52861f29015fd0a435b9da632712d3eae81517 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Wed, 10 Dec 2025 01:11:10 -0800 Subject: [PATCH 59/64] docs: increase text contrast and refactor js tabs functions --- docs/_sass/custom/custom.scss | 14 ++++++------ docs/_sass/custom/tabs.scss | 2 +- docs/assets/js/tabs.js | 42 ++++++++++++++++++++--------------- 3 files changed, 32 insertions(+), 26 deletions(-) diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss index 1b65f7a0f..2b054d46c 100644 --- a/docs/_sass/custom/custom.scss +++ b/docs/_sass/custom/custom.scss @@ -34,8 +34,7 @@ h2, h3, h4, h5, -h6, -h7 { +h6 { font-family: 'Source Serif Pro', serif !important; color: #002676 !important; line-height: 1.15; @@ -69,13 +68,13 @@ aside { &:hover { background-color: rgba(0, 38, 118, 0.05); - color: #C41230; + color: #941120; text-decoration: none; } &.active { font-weight: 600; - color: #C41230; + color: #941120; background-color: rgba(196, 18, 48, 0.03); } } @@ -177,10 +176,10 @@ pre code { .note { background-color: rgba(0, 123, 192, 0.05); border-left-color: #007BC0; - color: #007BC0; + color: #005F95; >p:first-child strong:first-child { - color: #007BC0; + color: #005F95; } } @@ -201,10 +200,11 @@ pre code { color: #941120; >p:first-child strong:first-child { - color: #C41230; + color: #941120; } } + .tip { background-color: rgba(54, 143, 51, 0.05); border-left-color: #368f33; diff --git a/docs/_sass/custom/tabs.scss b/docs/_sass/custom/tabs.scss index d416a51f7..4cd1b6a30 100644 --- a/docs/_sass/custom/tabs.scss +++ b/docs/_sass/custom/tabs.scss @@ -23,7 +23,7 @@ transition: all 0.2s ease; &:hover { - color: #007BC0; + color: #005F95; background-color: rgba(0, 123, 192, 0.05); } diff --git a/docs/assets/js/tabs.js b/docs/assets/js/tabs.js index bdf0ace56..513a04bd3 100644 --- a/docs/assets/js/tabs.js +++ b/docs/assets/js/tabs.js @@ -1,25 +1,31 @@ // Simple Tab Switching Logic -document.addEventListener('DOMContentLoaded', function () { - const tabContainers = document.querySelectorAll('.code-tabs'); +function activateTab(clickedButton, container) { + const buttons = container.querySelectorAll('.tab-header button'); + const contents = container.querySelectorAll('.tab-content'); - tabContainers.forEach(container => { - const headers = container.querySelector('.tab-header'); - const buttons = headers.querySelectorAll('button'); - const contents = container.querySelectorAll('.tab-content'); + // Deactivate all + buttons.forEach(btn => btn.classList.remove('active')); + contents.forEach(content => content.classList.remove('active')); - buttons.forEach(button => { - button.addEventListener('click', () => { - buttons.forEach(btn => btn.classList.remove('active')); - contents.forEach(content => content.classList.remove('active')); + // Activate clicked button + clickedButton.classList.add('active'); - button.classList.add('active'); + // Activate corresponding content + const tabId = clickedButton.getAttribute('data-tab'); + const content = container.querySelector(`.tab-content[data-tab="${tabId}"]`); + if (content) { + content.classList.add('active'); + } +} - const tabId = button.getAttribute('data-tab'); - const content = container.querySelector(`.tab-content[data-tab="${tabId}"]`); - if (content) { - content.classList.add('active'); - } - }); - }); +function initTabContainer(container) { + const buttons = container.querySelectorAll('.tab-header button'); + buttons.forEach(button => { + button.addEventListener('click', () => activateTab(button, container)); }); +} + +document.addEventListener('DOMContentLoaded', () => { + const tabContainers = document.querySelectorAll('.code-tabs'); + tabContainers.forEach(initTabContainer); }); From 1c3355baf829f639320133eb6fb93981d8ea5368 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Wed, 10 Dec 2025 01:17:44 -0800 Subject: [PATCH 60/64] =?UTF-8?q?docs:=20Use=20`.dataset`=20over=20`getAtt?= =?UTF-8?q?ribute(=E2=80=A6)`?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/assets/js/tabs.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/assets/js/tabs.js b/docs/assets/js/tabs.js index 513a04bd3..e4ee598a5 100644 --- a/docs/assets/js/tabs.js +++ b/docs/assets/js/tabs.js @@ -11,7 +11,7 @@ function activateTab(clickedButton, container) { clickedButton.classList.add('active'); // Activate corresponding content - const tabId = clickedButton.getAttribute('data-tab'); + const tabId = clickedButton.dataset.tab; const content = container.querySelector(`.tab-content[data-tab="${tabId}"]`); if (content) { content.classList.add('active'); From 4cf65a65653a9e7b34afb7b759584632eacef6d0 Mon Sep 17 00:00:00 2001 From: JavierMtzRdz Date: Wed, 10 Dec 2025 13:14:27 -0800 Subject: [PATCH 61/64] docs: correct duplicated line on source-template page --- docs/api/covidcast-signals/_source-template.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/api/covidcast-signals/_source-template.md b/docs/api/covidcast-signals/_source-template.md index dc70411a2..2d1a10c40 100644 --- a/docs/api/covidcast-signals/_source-template.md +++ b/docs/api/covidcast-signals/_source-template.md @@ -16,7 +16,6 @@ grand_parent: Main Endpoint (COVIDcast) | **Date of last data revision:** | Never (see [data revision docs](#changelog)) | | **Temporal Scope Start** | DATE RELEASED TO API | | **License** | [LICENSE NAME](../covidcast_licensing.md#APPLICABLE-SECTION) | -* **License:** [LICENSE NAME](../covidcast_licensing.md#APPLICABLE-SECTION) A brief description of what this source measures. From 062b2e575f451eef8d90739713ace97ba16af45d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20=7B=E2=88=85=2C=20Rdz=7D?= <39629918+JavierMtzRdz@users.noreply.github.com> Date: Wed, 10 Dec 2025 13:24:49 -0800 Subject: [PATCH 62/64] Update docs/api/covidcast-signals/indicator-combination.md docs: eliminate redundant elements from indicator-combination.md Co-authored-by: george --- docs/api/covidcast-signals/indicator-combination.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index e71e77adc..420f3b883 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -38,10 +38,6 @@ See [COVIDcast Signal Changes](../covidcast_changelog.md) for general informatio Standard errors are now included in the `nmf_day_doc_fbc_fbs_ght` signal for all geo levels and dates, representing the estimated uncertainty in this signal. This uncertainty comes because the signal is a combination of other signals based on survey estimates or other estimates with margins of error. -* `nmf_day_doc_fbc_fbs_ght` - * all geo levels - * all dates - ## Overview From ef043cb6d073708c8d834372250e06313ffd8b3a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20=7B=E2=88=85=2C=20Rdz=7D?= <39629918+JavierMtzRdz@users.noreply.github.com> Date: Wed, 10 Dec 2025 13:26:21 -0800 Subject: [PATCH 63/64] docs: clarify wording of June 3, 2020 change Co-authored-by: george --- docs/api/covidcast-signals/indicator-combination.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/covidcast-signals/indicator-combination.md b/docs/api/covidcast-signals/indicator-combination.md index 420f3b883..2a082d6af 100644 --- a/docs/api/covidcast-signals/indicator-combination.md +++ b/docs/api/covidcast-signals/indicator-combination.md @@ -36,7 +36,7 @@ See [COVIDcast Signal Changes](../covidcast_changelog.md) for general informatio ### June 3, 2020 -Standard errors are now included in the `nmf_day_doc_fbc_fbs_ght` signal for all geo levels and dates, representing the estimated uncertainty in this signal. This uncertainty comes because the signal is a combination of other signals based on survey estimates or other estimates with margins of error. +Standard error is now included in the `nmf_day_doc_fbc_fbs_ght` signal for all geo levels and dates, representing the estimated uncertainty in this signal. This uncertainty comes about because the signal is a combination of other signals based on survey estimates or other estimates with margins of error. From c1abe26cd38e66057cc607f956f045e1f03cea8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Javier=20=7B=E2=88=85=2C=20Rdz=7D?= <39629918+JavierMtzRdz@users.noreply.github.com> Date: Wed, 10 Dec 2025 13:28:04 -0800 Subject: [PATCH 64/64] docs: clarify wording of February 14, 2025 change for google-symptoms Co-authored-by: george --- docs/api/covidcast-signals/google-symptoms.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md index 05349daa0..b041fd019 100644 --- a/docs/api/covidcast-signals/google-symptoms.md +++ b/docs/api/covidcast-signals/google-symptoms.md @@ -21,10 +21,10 @@ nav_order: 1 Click to expand ### March 14, 2025 -Google added earlier dates starting from 2017-08-15 and also fixed a gap of county-level data from November 14 2022 through February 20, 2023. +Google made earlier data available (back to August 15, 2017), and fixed a gap in county-level data between November 14, 2022 and February 20, 2023. ### February 14, 2025 -We added a new signal s07_raw_search and s07_smoothed_search. +Two new signals were added, relating to conjunctivitis: `s07_raw_search` and `s07_smoothed_search`.