Skip to content

Commit 32bc5ff

Browse files
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]>
1 parent 8598215 commit 32bc5ff

File tree

9 files changed

+105
-26
lines changed

9 files changed

+105
-26
lines changed

docs/api/covid_hosp.md

Lines changed: 70 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -88,12 +88,19 @@ https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=
8888

8989
```json
9090
{
91-
"result": 1,
92-
"epidata": [
91+
"epidata":
92+
[
9393
{
9494
"state": "MA",
95-
"issue": 20201116,
95+
"geocoded_state": null,
96+
"issue": 20240503,
9697
"date": 20200510,
98+
"critical_staffing_shortage_today_yes": 0,
99+
"critical_staffing_shortage_today_no": 0,
100+
"critical_staffing_shortage_today_not_reported": 84,
101+
"critical_staffing_shortage_anticipated_within_week_yes": 0,
102+
"critical_staffing_shortage_anticipated_within_week_no": 0,
103+
"critical_staffing_shortage_anticipated_within_week_not_reported": 84,
97104
"hospital_onset_covid": 53,
98105
"hospital_onset_covid_coverage": 84,
99106
"inpatient_beds": 15691,
@@ -141,18 +148,74 @@ https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=
141148
"adult_icu_bed_utilization_coverage": null,
142149
"adult_icu_bed_utilization_numerator": null,
143150
"adult_icu_bed_utilization_denominator": null,
144-
"inpatient_beds_utilization": 0.6978504972730191,
145-
"percent_of_inpatients_with_covid": 0.2902550897239881,
146-
"inpatient_bed_covid_utilization": 0.21056656682174496,
151+
"deaths_covid": 48,
152+
"deaths_covid_coverage": 73,
153+
"icu_patients_confirmed_influenza": null,
154+
"icu_patients_confirmed_influenza_coverage": 0,
155+
"on_hand_supply_therapeutic_a_casirivimab_imdevimab_courses": null,
156+
"on_hand_supply_therapeutic_b_bamlanivimab_courses": null,
157+
"on_hand_supply_therapeutic_c_bamlanivimab_etesevimab_courses": null,
158+
"previous_day_admission_adult_covid_confirmed_18_19": null,
159+
"previous_day_admission_adult_covid_confirmed_18_19_coverage": 0,
160+
"previous_day_admission_adult_covid_confirmed_20_29": null,
161+
"previous_day_admission_adult_covid_confirmed_20_29_coverage": 0,
162+
"previous_day_admission_adult_covid_confirmed_30_39": null,
163+
"previous_day_admission_adult_covid_confirmed_30_39_coverage": 0,
164+
"previous_day_admission_adult_covid_confirmed_40_49": null,
165+
"previous_day_admission_adult_covid_confirmed_40_49_coverage": 0,
166+
"previous_day_admission_adult_covid_confirmed_50_59": null,
167+
"previous_day_admission_adult_covid_confirmed_50_59_coverage": 0,
168+
"previous_day_admission_adult_covid_confirmed_60_69": null,
169+
"previous_day_admission_adult_covid_confirmed_60_69_coverage": 0,
170+
"previous_day_admission_adult_covid_confirmed_70_79": null,
171+
"previous_day_admission_adult_covid_confirmed_70_79_coverage": 0,
172+
"previous_day_admission_adult_covid_confirmed_80plus": null,
173+
"previous_day_admission_adult_covid_confirmed_80plus_coverage": 0,
174+
"previous_day_admission_adult_covid_confirmed_unknown": null,
175+
"previous_day_admission_adult_covid_confirmed_unknown_coverage": 0,
176+
"previous_day_admission_adult_covid_suspected_18_19": null,
177+
"previous_day_admission_adult_covid_suspected_18_19_coverage": 0,
178+
"previous_day_admission_adult_covid_suspected_20_29": null,
179+
"previous_day_admission_adult_covid_suspected_20_29_coverage": 0,
180+
"previous_day_admission_adult_covid_suspected_30_39": null,
181+
"previous_day_admission_adult_covid_suspected_30_39_coverage": 0,
182+
"previous_day_admission_adult_covid_suspected_40_49": null,
183+
"previous_day_admission_adult_covid_suspected_40_49_coverage": 0,
184+
"previous_day_admission_adult_covid_suspected_50_59": null,
185+
"previous_day_admission_adult_covid_suspected_50_59_coverage": 0,
186+
"previous_day_admission_adult_covid_suspected_60_69": null,
187+
"previous_day_admission_adult_covid_suspected_60_69_coverage": 0,
188+
"previous_day_admission_adult_covid_suspected_70_79": null,
189+
"previous_day_admission_adult_covid_suspected_70_79_coverage": 0,
190+
"previous_day_admission_adult_covid_suspected_80plus": null,
191+
"previous_day_admission_adult_covid_suspected_80plus_coverage": 0,
192+
"previous_day_admission_adult_covid_suspected_unknown": null,
193+
"previous_day_admission_adult_covid_suspected_unknown_coverage": 0,
194+
"previous_day_admission_influenza_confirmed": null,
195+
"previous_day_admission_influenza_confirmed_coverage": 0,
196+
"previous_day_deaths_covid_and_influenza": null,
197+
"previous_day_deaths_covid_and_influenza_coverage": 0,
198+
"previous_day_deaths_influenza": null,
199+
"previous_day_deaths_influenza_coverage": 0,
200+
"previous_week_therapeutic_a_casirivimab_imdevimab_courses_used": null,
201+
"previous_week_therapeutic_b_bamlanivimab_courses_used": null,
202+
"previous_week_therapeutic_c_bamlanivimab_etesevimab_courses_used": null,
203+
"total_patients_hospitalized_confirmed_influenza": null,
204+
"total_patients_hospitalized_confirmed_influenza_coverage": 0,
205+
"total_patients_hospitalized_confirmed_influenza_covid": null,
206+
"total_patients_hospitalized_confirmed_influenza_covid_coverage": null,
207+
"inpatient_beds_utilization": 0.697850497273019,
208+
"percent_of_inpatients_with_covid": 0.290255089723988,
209+
"inpatient_bed_covid_utilization": 0.210566566821745,
147210
"adult_icu_bed_covid_utilization": null,
148211
"adult_icu_bed_utilization": null
149212
}
150213
],
214+
"result": 1,
151215
"message": "success"
152216
}
153217
```
154218

155-
156219
# Code Samples
157220

158221
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).

docs/api/covidcast-signals/google-survey.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ nav_order: 2
1818

1919
## Overview
2020

21-
Data source based on Google-run symptom surveys, through publisher websites,
21+
Data source based on [Google-run symptom surveys](https://9to5google.com/2020/03/23/google-coronavirus-survey/), through publisher websites,
2222
their Opinions Reward app, and similar applications. Respondents can opt to skip
2323
the survey and complete a different one if they prefer not to answer. The survey
2424
is just one question long, and asks "Do you know someone in your community who

docs/api/covidcast-signals/google-symptoms.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ nav_order: 1
2121
## Overview
2222

2323
This data source is based on the [COVID-19 Search Trends symptoms
24-
dataset](http://goo.gle/covid19symptomdataset). Using
24+
dataset](https://console.cloud.google.com/marketplace/product/bigquery-public-datasets/covid19-search-trends?hl=en-GB). Using
2525
this search data, we estimate the volume of searches mapped to symptom sets related
2626
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.
2727

docs/api/covidcast-signals/safegraph.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,16 @@ surface signals from two such datasets.
3131

3232
**This dataset is no longer updated after April 19th, 2021.**
3333

34-
Data source based on [social distancing
35-
metrics](https://docs.safegraph.com/docs/social-distancing-metrics). SafeGraph
34+
Data source based on the [Social Distancing Metrics](https://docs.safegraph.com/docs/social-distancing-metrics) data product. SafeGraph
3635
provided this data for individual census block groups, using differential
3736
privacy to protect individual people's data privacy.
3837

3938
Delphi creates features of the SafeGraph data at the census block group level,
4039
then aggregates these features to the county and state levels. The aggregated
4140
data is freely available through the COVIDcast API.
4241

43-
For precise definitions of the quantities below, consult the [SafeGraph social
44-
distancing metric
42+
For precise definitions of the quantities below, consult the [SafeGraph Social
43+
Distancing Metric
4544
documentation](https://docs.safegraph.com/docs/social-distancing-metrics).
4645

4746
| Signal | Description |
@@ -119,7 +118,7 @@ available from the [US Census Bureau: North American Industry Classification
119118
System](https://www.census.gov/eos/www/naics/index.html).
120119

121120
The number of POIs coded as bars is much smaller than the number of POIs coded as restaurants.
122-
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.
121+
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.
123122
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.
124123

125124
### Lag
@@ -131,7 +130,10 @@ COVIDcast API.
131130

132131
## Limitations
133132

134-
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:
133+
SafeGraph's [Social Distancing Metrics](https://docs.safegraph.com/docs/social-distancing-metrics)
134+
and [Weekly Patterns](https://docs.safegraph.com/docs/weekly-patterns) data products
135+
are based on mobile devices that are members of SafeGraph panels, which is not necessarily the same thing as measuring the general public.
136+
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:
135137

136138
* **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.
137139
* **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.

docs/api/flusurv.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,15 @@ General topics not specific to any particular endpoint are discussed in the
2020
FluSurv-NET data (flu hospitaliation rates) from CDC.
2121

2222
See also:
23-
- https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html
24-
- https://wwwnc.cdc.gov/eid/article/21/9/14-1912_article
23+
- <https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html>
24+
- <https://wwwnc.cdc.gov/eid/article/21/9/14-1912_article>
2525
- Chaves, S., Lynfield, R., Lindegren, M., Bresee, J., & Finelli, L. (2015).
2626
The US Influenza Hospitalization Surveillance Network. Emerging Infectious
27-
Diseases, 21(9), 1543-1550. https://dx.doi.org/10.3201/eid2109.141912.
27+
Diseases, 21(9), 1543-1550. <https://dx.doi.org/10.3201/eid2109.141912>.
2828

2929
# The API
3030

31-
The base URL is: https://api.delphi.cmu.edu/epidata/flusurv/
31+
The base URL is: <https://api.delphi.cmu.edu/epidata/flusurv/>
3232

3333
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
3434

@@ -81,7 +81,7 @@ Notes:
8181
# Example URLs
8282

8383
### FluSurv on 2020w01 (CA)
84-
https://api.delphi.cmu.edu/epidata/flusurv/?locations=ca&epiweeks=202001
84+
<https://api.delphi.cmu.edu/epidata/flusurv/?locations=ca&epiweeks=202001>
8585

8686
```json
8787
{

docs/api/gft.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ General topics not specific to any particular endpoint are discussed in the
1818
## Google Flu Trends Data
1919

2020
Estimate of influenza activity based on volume of certain search queries. Google has discontinued Flu Trends, and this is now a static endpoint.
21-
- Source: [Google](https://www.google.org/flutrends/)
21+
- Data Source: [Google Flu Trends Estimates](https://www.google.com/publicdata/explore?ds=z3bsqef7ki44ac_) ([context](https://en.wikipedia.org/wiki/Google_Flu_Trends))
2222
- Temporal Resolution: Weekly from 2003w40 until 2015w32
2323
- 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))
2424
- Open access

docs/api/ght.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 2
77

88
# Google Health Trends
99

10-
This is the API documentation for accessing the Google Health Trends (`ght`)
10+
This is the API documentation for accessing the [Google Health Trends](https://trends.google.com/trends/fullscreen/m/IN) (`ght`)
1111
endpoint of [Delphi](https://delphi.cmu.edu/)'s epidemiological data.
1212

1313
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
1717

1818
## Google Health Trends Data
1919

20-
Estimate of influenza activity based on volume of certain search queries. ... <!-- TODO -->
20+
Estimate of influenza activity based on volume of certain search queries.
21+
This data may be useful for real-time monitoring of diseases, as in:
22+
23+
- 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.
24+
- Abel Brodeur, Andrew E. Clark, Sarah Fleche, Nattavudh Powdthavee.
25+
[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.
26+
- 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.
2127

2228
# The API
2329

docs/api/nidss_dengue.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 2
77

88
# NIDSS Dengue
99

10-
This is the documentation of the API for accessing the NIDSS Dengue (`nidss_dengue`) endpoint of
10+
This is the documentation of the API for accessing the Taiwan National Infectious Disease Statistics System Dengue (`nidss_dengue`) endpoint of
1111
the [Delphi](https://delphi.cmu.edu/)'s epidemiological data.
1212

1313
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
1717

1818
## NIDSS Dengue Data
1919

20-
Counts of confirmed dengue cases from Taiwan's NIDSS.
20+
Counts of confirmed dengue cases from Taiwan's National Infectious Disease Statistics System (NIDSS).
2121
- Data source: [Taiwan CDC](http://nidss.cdc.gov.tw/en/SingleDisease.aspx?dc=1&dt=4&disease=061&position=1)
2222
- Temporal Resolution: Weekly from 2003w01
2323
- 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')
113113
res <- Epidata$nidss_dengue(list('nationwide'), list(201440, Epidata$range(201501, 201510)))
114114
cat(paste(res$result, res$message, length(res$epidata), "\n"))
115115
````
116+
117+
# Source and Licensing
118+
119+
The full text of the NIDSS Dengue license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license).

docs/api/nidss_flu.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 2
77

88
# NIDSS Flu
99

10-
This is the documentation of the API for accessing the NIDSS Flu (`nidss_flu`) endpoint of
10+
This is the documentation of the API for accessing the Taiwan National Infectious Disease Statistics System Flu (`nidss_flu`) endpoint of
1111
the [Delphi](https://delphi.cmu.edu/)'s epidemiological data.
1212

1313
General topics not specific to any particular endpoint are discussed in the
@@ -134,3 +134,7 @@ source('delphi_epidata.R')
134134
res <- Epidata$nidss_flu(list('nationwide'), list(201440, Epidata$range(201501, 201510)))
135135
cat(paste(res$result, res$message, length(res$epidata), "\n"))
136136
````
137+
138+
# Source and Licensing
139+
140+
The full text of the NIDSS Flu license information is available on the Taiwan Digital Development Department's [website](https://data.gov.tw/license).

0 commit comments

Comments
 (0)