Skip to content

Commit f15b722

Browse files
committed
Edits to add descriptve links to other endpoints
1 parent c72565a commit f15b722

File tree

8 files changed

+22
-18
lines changed

8 files changed

+22
-18
lines changed

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?q=search&referrer=search&project=southern-guild-298314). 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: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,17 +31,17 @@ 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 [Social Distancing
35+
Metrics](https://docs.safegraph.com/docs/social-distancing-metrics). SafeGraph
3636
provided this data for individual census block groups, using differential
3737
privacy to protect individual people's data privacy.
3838

3939
Delphi creates features of the SafeGraph data at the census block group level,
4040
then aggregates these features to the county and state levels. The aggregated
4141
data is freely available through the COVIDcast API.
4242

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

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

121121
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.
122+
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.
123123
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.
124124

125125
### Lag
@@ -131,7 +131,7 @@ COVIDcast API.
131131

132132
## Limitations
133133

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:
134+
SafeGraph's [Social Distancing Metrics](https://docs.safegraph.com/docs/social-distancing-metrics) and [Weekly Patterns](https://docs.safegraph.com/docs/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:
135135

136136
* **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.
137137
* **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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,10 @@ 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_)
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))
24+
- Wikipedia Article: <https://en.wikipedia.org/wiki/Google_Flu_Trends>
2425
- Open access
2526

2627
# The API

docs/api/ght.md

Lines changed: 5 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,10 @@ 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+
22+
See also:
23+
-
2124

2225
# The API
2326

docs/api/nidss_dengue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
3636
| Parameter | Description | Type |
3737
| --- | --- | --- |
3838
| `epiweeks` | epiweeks | `list` of epiweeks |
39-
| `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 |
39+
| `locations` | **regions** (nationwide, central, eastern, Kaoping, northern, southern, Taipei) and **counties or cities** (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) | `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 |
4040

4141
## Response
4242

docs/api/nidss_flu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
3838
| Parameter | Description | Type |
3939
| --- | --- | --- |
4040
| `epiweeks` | epiweeks | `list` of epiweeks |
41-
| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt) labels |
41+
| `regions` | **regions** (nationwide, central, eastern, Kaoping, northern, southern, Taipei) | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt) labels |
4242

4343
### Optional
4444

0 commit comments

Comments
 (0)