Added or edited descriptive links to "other endpoints" page (#1552)

* Edited language regarding weekly deaths * Edits to add descriptve links to other endpoints * second set of committs for descriptive links issue * Wording changes for clarity --------- Co-authored-by: nmdefries <[email protected]>
cmu-delphi · Nov 4, 2024 · 32bc5ff · 32bc5ff
1 parent 8598215
commit 32bc5ff
Show file tree

Hide file tree

Showing 9 changed files with 105 additions and 26 deletions.
diff --git a/docs/api/covid_hosp.md b/docs/api/covid_hosp.md
@@ -88,12 +88,19 @@ https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=
 
 ```json
 {
-    "result": 1,
-    "epidata": [
+    "epidata":
+    [
         {
             "state": "MA",
-            "issue": 20201116,
+            "geocoded_state": null,
+            "issue": 20240503,
             "date": 20200510,
+            "critical_staffing_shortage_today_yes": 0,
+            "critical_staffing_shortage_today_no": 0,
+            "critical_staffing_shortage_today_not_reported": 84,
+            "critical_staffing_shortage_anticipated_within_week_yes": 0,
+            "critical_staffing_shortage_anticipated_within_week_no": 0,
+            "critical_staffing_shortage_anticipated_within_week_not_reported": 84,
             "hospital_onset_covid": 53,
             "hospital_onset_covid_coverage": 84,
             "inpatient_beds": 15691,
@@ -141,18 +148,74 @@ https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=
             "adult_icu_bed_utilization_coverage": null,
             "adult_icu_bed_utilization_numerator": null,
             "adult_icu_bed_utilization_denominator": null,
-            "inpatient_beds_utilization": 0.6978504972730191,
-            "percent_of_inpatients_with_covid": 0.2902550897239881,
-            "inpatient_bed_covid_utilization": 0.21056656682174496,
+            "deaths_covid": 48,
+            "deaths_covid_coverage": 73,
+            "icu_patients_confirmed_influenza": null,
+            "icu_patients_confirmed_influenza_coverage": 0,
+            "on_hand_supply_therapeutic_a_casirivimab_imdevimab_courses": null,
+            "on_hand_supply_therapeutic_b_bamlanivimab_courses": null,
+            "on_hand_supply_therapeutic_c_bamlanivimab_etesevimab_courses": null,
+            "previous_day_admission_adult_covid_confirmed_18_19": null,
+            "previous_day_admission_adult_covid_confirmed_18_19_coverage": 0,
+            "previous_day_admission_adult_covid_confirmed_20_29": null,
+            "previous_day_admission_adult_covid_confirmed_20_29_coverage": 0,
+            "previous_day_admission_adult_covid_confirmed_30_39": null,
+            "previous_day_admission_adult_covid_confirmed_30_39_coverage": 0,
+            "previous_day_admission_adult_covid_confirmed_40_49": null,
+            "previous_day_admission_adult_covid_confirmed_40_49_coverage": 0,
+            "previous_day_admission_adult_covid_confirmed_50_59": null,
+            "previous_day_admission_adult_covid_confirmed_50_59_coverage": 0,
+            "previous_day_admission_adult_covid_confirmed_60_69": null,
+            "previous_day_admission_adult_covid_confirmed_60_69_coverage": 0,
+            "previous_day_admission_adult_covid_confirmed_70_79": null,
+            "previous_day_admission_adult_covid_confirmed_70_79_coverage": 0,
+            "previous_day_admission_adult_covid_confirmed_80plus": null,
+            "previous_day_admission_adult_covid_confirmed_80plus_coverage": 0,
+            "previous_day_admission_adult_covid_confirmed_unknown": null,
+            "previous_day_admission_adult_covid_confirmed_unknown_coverage": 0,
+            "previous_day_admission_adult_covid_suspected_18_19": null,
+            "previous_day_admission_adult_covid_suspected_18_19_coverage": 0,
+            "previous_day_admission_adult_covid_suspected_20_29": null,
+            "previous_day_admission_adult_covid_suspected_20_29_coverage": 0,
+            "previous_day_admission_adult_covid_suspected_30_39": null,
+            "previous_day_admission_adult_covid_suspected_30_39_coverage": 0,
+            "previous_day_admission_adult_covid_suspected_40_49": null,
+            "previous_day_admission_adult_covid_suspected_40_49_coverage": 0,
+            "previous_day_admission_adult_covid_suspected_50_59": null,
+            "previous_day_admission_adult_covid_suspected_50_59_coverage": 0,
+            "previous_day_admission_adult_covid_suspected_60_69": null,
+            "previous_day_admission_adult_covid_suspected_60_69_coverage": 0,
+            "previous_day_admission_adult_covid_suspected_70_79": null,
+            "previous_day_admission_adult_covid_suspected_70_79_coverage": 0,
+            "previous_day_admission_adult_covid_suspected_80plus": null,
+            "previous_day_admission_adult_covid_suspected_80plus_coverage": 0,
+            "previous_day_admission_adult_covid_suspected_unknown": null,
+            "previous_day_admission_adult_covid_suspected_unknown_coverage": 0,
+            "previous_day_admission_influenza_confirmed": null,
+            "previous_day_admission_influenza_confirmed_coverage": 0,
+            "previous_day_deaths_covid_and_influenza": null,
+            "previous_day_deaths_covid_and_influenza_coverage": 0,
+            "previous_day_deaths_influenza": null,
+            "previous_day_deaths_influenza_coverage": 0,
+            "previous_week_therapeutic_a_casirivimab_imdevimab_courses_used": null,
+            "previous_week_therapeutic_b_bamlanivimab_courses_used": null,
+            "previous_week_therapeutic_c_bamlanivimab_etesevimab_courses_used": null,
+            "total_patients_hospitalized_confirmed_influenza": null,
+            "total_patients_hospitalized_confirmed_influenza_coverage": 0,
+            "total_patients_hospitalized_confirmed_influenza_covid": null,
+            "total_patients_hospitalized_confirmed_influenza_covid_coverage": null,
+            "inpatient_beds_utilization": 0.697850497273019,
+            "percent_of_inpatients_with_covid": 0.290255089723988,
+            "inpatient_bed_covid_utilization": 0.210566566821745,
             "adult_icu_bed_covid_utilization": null,
             "adult_icu_bed_utilization": null
         }
     ],
+    "result": 1,
     "message": "success"
 }
 ```
 
-
 # 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).

diff --git a/docs/api/covidcast-signals/google-survey.md b/docs/api/covidcast-signals/google-survey.md
@@ -18,7 +18,7 @@ nav_order: 2
 
 ## Overview
 
-Data source based on Google-run symptom surveys, through publisher websites,
+Data source based on [Google-run symptom surveys](https://9to5google.com/2020/03/23/google-coronavirus-survey/), through publisher websites,
 their Opinions Reward app, and similar applications. Respondents can opt to skip
 the survey and complete a different one if they prefer not to answer. The survey
 is just one question long, and asks "Do you know someone in your community who

diff --git a/docs/api/covidcast-signals/google-symptoms.md b/docs/api/covidcast-signals/google-symptoms.md
@@ -21,7 +21,7 @@ nav_order: 1
 ## Overview
 
 This data source is based on the [COVID-19 Search Trends symptoms
-dataset](http://goo.gle/covid19symptomdataset). Using
+dataset](https://console.cloud.google.com/marketplace/product/bigquery-public-datasets/covid19-search-trends?hl=en-GB). Using
 this search data, we estimate the volume of searches mapped to symptom sets related
 to COVID-19. The resulting daily dataset for each region shows the average relative frequency of searches for each symptom set. The signals are measured in arbitrary units that are normalized for overall search users in the region and scaled by the maximum value of the normalized popularity within a geographic region across a specific time range. **Values are comparable across signals in the same location but NOT across geographic regions**. For example, within a state, we can compare `s01_smoothed_search` and `s02_smoothed_search`. However, we cannot compare `s01_smoothed_search` between states. Larger numbers represent increased relative popularity of symptom-related searches.
 

diff --git a/docs/api/covidcast-signals/safegraph.md b/docs/api/covidcast-signals/safegraph.md
@@ -31,17 +31,16 @@ surface signals from two such datasets.
 
 **This dataset is no longer updated after April 19th, 2021.**
 
-Data source based on [social distancing
-metrics](https://docs.safegraph.com/docs/social-distancing-metrics).  SafeGraph
+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. 
 
 Delphi creates features of the SafeGraph data at the census block group level,
 then aggregates these features to the county and state levels. The aggregated
 data is freely available through the COVIDcast API.
 
-For precise definitions of the quantities below, consult the [SafeGraph social
-distancing metric
+For precise definitions of the quantities below, consult the [SafeGraph Social
+Distancing Metric
 documentation](https://docs.safegraph.com/docs/social-distancing-metrics).
 
 | Signal | Description |
@@ -119,7 +118,7 @@ available from the [US Census Bureau: North American Industry Classification
 System](https://www.census.gov/eos/www/naics/index.html).
 
 The number of POIs coded as bars is much smaller than the number of POIs coded as restaurants.
-SafeGraph's Weekly Patterns data consistently lacks data on bar visits for Alaska, Delaware, Maine, North Dakota, New Hampshire, South Dakota, Vermont, West Virginia, and Wyoming.
+SafeGraph's [Weekly Patterns](https://docs.safegraph.com/docs/weekly-patterns) data consistently lacks data on bar visits for Alaska, Delaware, Maine, North Dakota, New Hampshire, South Dakota, Vermont, West Virginia, and Wyoming.
 For certain dates, bar visits data is also missing for District of Columbia, Idaho and Washington. Restaurant visits data is available for all of the states, as well as the District of Columbia and Puerto Rico.
 
 ### Lag
@@ -131,7 +130,10 @@ COVIDcast API.
 
 ## Limitations
 
-SafeGraph's Social Distancing Metrics and Weekly Patterns are based on mobile devices that are members of SafeGraph panels, which is not necessarily the same thing as measuring the general public. These counts do not represent absolute counts, and only count visits by members of the panel in that region. This can result in several biases:
+SafeGraph's [Social Distancing Metrics](https://docs.safegraph.com/docs/social-distancing-metrics) 
+and [Weekly Patterns](https://docs.safegraph.com/docs/weekly-patterns) data products
+are based on mobile devices that are members of SafeGraph panels, which is not necessarily the same thing as measuring the general public. 
+These counts do not represent absolute counts, and only count visits by members of the panel in that region. This can result in several biases:
 
 * **Geographic bias.** If some regions have a greater density of SafeGraph panel members as a percentage of the population than other regions, comparisons of metrics between regions may be biased. Regions with more SafeGraph panel members will appear to have more visits counted, even if the rate of visits in the general population is the same.
 * **Demographic bias.** SafeGraph panels may not be representative of the local population as a whole. For example, [some research suggests](https://doi.org/10.1145/3442188.3445881) that "older and non-white voters are less likely to be captured by mobility data", so this data will not accurately reflect behavior in those populations. Since population demographics vary across the United States, this can also contribute to geographic biases.
diff --git a/docs/api/flusurv.md b/docs/api/flusurv.md
@@ -20,15 +20,15 @@ General topics not specific to any particular endpoint are discussed in the
 FluSurv-NET data (flu hospitaliation rates) from CDC.
 
 See also:
-  - https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html
-  - https://wwwnc.cdc.gov/eid/article/21/9/14-1912_article
+  - <https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html>
+  - <https://wwwnc.cdc.gov/eid/article/21/9/14-1912_article>
   - Chaves, S., Lynfield, R., Lindegren, M., Bresee, J., & Finelli, L. (2015).
     The US Influenza Hospitalization Surveillance Network. Emerging Infectious
-    Diseases, 21(9), 1543-1550. https://dx.doi.org/10.3201/eid2109.141912.
+    Diseases, 21(9), 1543-1550. <https://dx.doi.org/10.3201/eid2109.141912>.
 
 # The API
 
-The base URL is: https://api.delphi.cmu.edu/epidata/flusurv/
+The base URL is: <https://api.delphi.cmu.edu/epidata/flusurv/>
 
 See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
 
@@ -81,7 +81,7 @@ Notes:
 # Example URLs
 
 ### FluSurv on 2020w01 (CA)
-https://api.delphi.cmu.edu/epidata/flusurv/?locations=ca&epiweeks=202001
+<https://api.delphi.cmu.edu/epidata/flusurv/?locations=ca&epiweeks=202001>
 
 ```json
 {

diff --git a/docs/api/gft.md b/docs/api/gft.md
@@ -18,7 +18,7 @@ General topics not specific to any particular endpoint are discussed in the
 ## Google Flu Trends Data
 
 Estimate of influenza activity based on volume of certain search queries. Google has discontinued Flu Trends, and this is now a static endpoint.
- - Source: [Google](https://www.google.org/flutrends/)
+ - 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

diff --git a/docs/api/ght.md b/docs/api/ght.md
@@ -7,7 +7,7 @@ nav_order: 2
 
 # Google Health Trends
 
-This is the API documentation for accessing the Google Health Trends (`ght`)
+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.
 
 General topics not specific to any particular endpoint are discussed in the
@@ -17,7 +17,13 @@ General topics not specific to any particular endpoint are discussed in the
 
 ## Google Health Trends Data
 
-Estimate of influenza activity based on volume of certain search queries. ... <!-- TODO -->
+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.
+[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.
 
 # The API
 

diff --git a/docs/api/nidss_dengue.md b/docs/api/nidss_dengue.md
@@ -7,7 +7,7 @@ nav_order: 2
 
 # NIDSS Dengue
 
-This is the documentation of the API for accessing the NIDSS Dengue (`nidss_dengue`) endpoint of
+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.
 
 General topics not specific to any particular endpoint are discussed in the
@@ -17,7 +17,7 @@ General topics not specific to any particular endpoint are discussed in the
 
 ## NIDSS Dengue Data
 
-Counts of confirmed dengue cases from Taiwan's NIDSS.
+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))
@@ -113,3 +113,7 @@ source('delphi_epidata.R')
 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
+
+The full text of the NIDSS Dengue license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license).
diff --git a/docs/api/nidss_flu.md b/docs/api/nidss_flu.md
@@ -7,7 +7,7 @@ nav_order: 2
 
 # NIDSS Flu
 
-This is the documentation of the API for accessing the NIDSS Flu (`nidss_flu`) endpoint of
+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.
 
 General topics not specific to any particular endpoint are discussed in the
@@ -134,3 +134,7 @@ source('delphi_epidata.R')
 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
+
+The full text of the NIDSS Flu license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license).