Skip to content

Commit b5f61c3

Browse files
committed
docs: add geographic reference to other endpoints.
1 parent 14df264 commit b5f61c3

18 files changed

+480
-54
lines changed

docs/api/cdc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ nav_order: 2
1313
| :--- | :--- |
1414
| **Source Name** | `cdc` |
1515
| **Data Source** | CDC influenza surveillance data |
16-
| **Geographic Coverage** | National, HHS regions, Census divisions, and US states |
16+
| **Geographic Coverage** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) |
1717
| **Temporal Resolution** | Weekly (Epiweek) |
1818
| **Update Frequency** | Inactive - No longer updated |
1919
| **Earliest Date** | 2013w02 (2013-01-06) |

docs/api/covid_hosp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 2
1212
* **Data source:** [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh)
1313
* **Earliest issue available:** 2020-01-01
1414
* **Temporal Resolution:** Daily
15-
* **Spatial Resolution:** US States plus DC, PR, and VI
15+
* **Spatial Resolution:** US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories))
1616
* **License:** [Public Domain US Government](https://www.usa.gov/government-works)
1717

1818
## Overview

docs/api/covid_hosp_facility_lookup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ See [this documentation](README.md) for details on specifying locations and date
4444

4545
| Parameter | Description | Type |
4646
|-------------|-----------------------------------|--------|
47-
| `state` | two-letter state abbreviation | string |
47+
| `state` | two-letter state abbreviation (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | string |
4848
| `ccn` | facility CMS Certification Number | string |
4949
| `city` | city name | string |
5050
| `zip` | 5-digit ZIP code | string |

docs/api/digital_surveillance_sensors.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ General topics not specific to any particular endpoint are discussed in the
1616
[contributing](README.md#contributing), [citing](README.md#citing), and
1717
[data licensing](README.md#data-licensing).
1818

19-
**Note:** this repository was built to support modeling and forecasting efforts
19+
{: .note}
20+
> **Note:** this repository was built to support modelling and forecasting efforts
2021
surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic,
2122
syndromic surveillance data, like ILI data (influenza-like illness) through
2223
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
3940
| Parameter | Description | Type |
4041
| --- | --- | --- |
4142
| `epiweeks` | epiweeks | `list` of epiweeks |
42-
| `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 <!-- TODO: check --> |
43+
| `locations` | locations | `list` of location codes: `nat`, HHS regions, Census divisions, or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) |
4344
| `names` | sensor names | `list` of string |
4445

45-
Notes:
46-
* Names of open sensors (no `auth` token required): `sar3`, `epic`, `arch`
47-
* Names of sensors requiring `auth` token: `twtr`, `gft`, `ght`, `ghtj`, `cdc`, `quid`, `wiki`
46+
{: .note}
47+
> **Notes:**
48+
> * Names of open sensors (no `auth` token required): `sar3`, `epic`, `arch`
49+
> * Names of sensors requiring `auth` token: `twtr`, `gft`, `ght`, `ghtj`, `cdc`, `quid`, `wiki`
4850
4951
### Optional
5052

docs/api/ecdc_ili.md

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

1111
* **Source name:** `ecdc_ili`
1212
* **Earliest issue available:** 2003w40
13-
* **Regions available:** European countries ([full list](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/ecdc_regions.txt))
13+
* **Regions available:** European countries (see [Geographic Codes](geographic_codes.html#european-countries))
1414
* **Time type available:** epiweek
1515
* **License:** Open access
1616

@@ -50,7 +50,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
5050
| Parameter | Description | Type |
5151
| --- | --- | --- |
5252
| `epiweeks` | epiweeks | `list` of epiweeks |
53-
| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/ecdc_regions.txt) labels |
53+
| `regions` | regions | `list` of European country labels (see [Geographic Codes](geographic_codes.html#european-countries)) |
5454

5555
### Optional
5656

docs/api/flusurv.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ nav_order: 2
1111
* **Source name:** `flusurv`
1212
* **Earliest issue available:** 2009w40
1313
* **Data source:** [Laboratory-Confirmed Influenza Hospitalizations](https://gis.cdc.gov/GRASP/Fluview/FluHospRates.html)
14-
* **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))
14+
* **Location available:** See [Geographic Codes](geographic_codes.html#flusurv-locations) for full list
1515
* **Time type available:** epiweek
1616
<!-- * **License:** Open access -->
1717

@@ -53,7 +53,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
5353
| Parameter | Description | Type |
5454
| --- | --- | --- |
5555
| `epiweeks` | epiweeks | `list` of epiweeks |
56-
| `locations` | locations | `list` of [location](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/flusurv_locations.txt) labels |
56+
| `locations` | locations | `list` of location labels (see [Geographic Codes](geographic_codes.html#flusurv-locations)) |
5757

5858
### Optional
5959

docs/api/fluview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 1
1212
* **Data source:** [United States Centers for Disease Control and Prevention](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html) (CDC)
1313
* **Earliest issue available:** 1997w40
1414
* **Date of last change:** [Weekly (typically Fridays)]
15-
* **Available for:** nat, hhs1-hhs10, and cen1-cen9 ([full list of regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt))
15+
* **Available for:** nat, hhs1-hhs10, and cen1-cen9 (see [Geographic Codes](geographic_codes.html#us-regions-and-states))
1616
* **Time type available:** epiweek
1717
* **License:** Open Access / [CDC](http://gis.cdc.gov/grasp/fluview/fluportaldashboard.html)
1818

@@ -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-
| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt) labels |
39+
| `regions` | regions | `list` of region labels: `nat`, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) |
4040

4141
### Optional
4242

@@ -46,9 +46,9 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
4646
| `lag` | # weeks between each epiweek and its issue | integer |
4747
| `auth` | password for private imputed data | string |
4848

49-
Notes:
50-
- If both `issues` and `lag` are specified, only `issues` is used.
51-
If neither is specified, the current issues are used.
49+
> **Notes:**
50+
> - If both `issues` and `lag` are specified, only `issues` is used.
51+
> - If neither is specified, the current issues are used.
5252
5353
## Response
5454

docs/api/fluview_clinical.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ nav_order: 1
1010

1111
* **Source name:** `fluview_clinical`
1212
* **Earliest issue available:** 2010w40
13-
* **Available for:** nat, hhs1-hhs10, and cen1-cen9 ([full list of regions](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt))
13+
* **Available for:** nat, hhs1-hhs10, and cen1-cen9 (see [Geographic Codes](geographic_codes.html#us-regions-and-states))
1414
* **Time type available:** epiweek
1515
* **License:** Open Access
1616

@@ -46,7 +46,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
4646
| Parameter | Description | Type |
4747
| --- | --- | --- |
4848
| `epiweeks` | epiweeks | `list` of epiweeks |
49-
| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt) labels |
49+
| `regions` | regions | `list` of region labels: `nat`, `hhs1`-`hhs10`, `cen1`-`cen9` (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) |
5050

5151
### Optional
5252

0 commit comments

Comments
 (0)