Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/api/afhsb.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,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 [region](../../labels/regions.txt), [state](../../labels/states.txt), or 3-letter country code labels |
| `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), or 3-letter country code labels |
| `flu_types` | flu types | `list` of disjoint (`flu1`, `flu2-flu1`, `flu3-flu2`, `ili-flu3`) or subset (`flu2`, `flu3`, `ili`) flu type labels |

## Response
Expand Down
2 changes: 1 addition & 1 deletion docs/api/cdc.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,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 [region](../../labels/regions.txt)/[state](../../labels/states.txt) labels <!-- TODO: check --> |
| `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 --> |

## Response

Expand Down
2 changes: 1 addition & 1 deletion docs/api/covid_hosp.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,7 @@ https://delphi.cmu.edu/epidata/covid_hosp_state_timeseries/?states=MA&dates=2020

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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 sample shows how to import the library and fetch MA on 2020-05-10
(per most recent issue).

Expand Down
2 changes: 1 addition & 1 deletion docs/api/covid_hosp_facility.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ https://delphi.cmu.edu/epidata/covid_hosp_facility/?hospital_pks=390119&collecti

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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 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).
Expand Down
2 changes: 1 addition & 1 deletion docs/api/covid_hosp_facility_lookup.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ https://delphi.cmu.edu/epidata/covid_hosp_facility_lookup/?city=southlake

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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 sample shows how to import the library and fetch facilities in
the city of Southlake (TX).

Expand Down
2 changes: 1 addition & 1 deletion docs/api/covidcast_meta.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ https://api.covidcast.cmu.edu/epidata/covidcast_meta/

## Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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)
Expand Down
4 changes: 2 additions & 2 deletions docs/api/flusurv.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,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/flusurv_locations.txt) labels |
| `locations` | locations | `list` of [location](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/flusurv_locations.txt) labels |

### Optional

Expand Down Expand Up @@ -105,7 +105,7 @@ https://delphi.cmu.edu/epidata/flusurv/?locations=ca&epiweeks=202001

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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 CA FluView Clinical data for epiweeks `201940` and `202001-202010` (11 weeks total).

### JavaScript (in a web browser)
Expand Down
6 changes: 3 additions & 3 deletions docs/api/fluview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ General topics not specific to any particular endpoint are discussed in the
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](http://www.hhs.gov/iea/regional/), [Census divisions](http://www.census.gov/econ/census/help/geography/regions_and_divisions.html), most States and Territories, and some Cities (full list [here](../../src/acquisition/fluview/fluview_locations.py))
- 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), 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
Expand All @@ -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](../../labels/regions.txt) labels |
| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt) labels |

### Optional

Expand Down Expand Up @@ -120,7 +120,7 @@ https://delphi.cmu.edu/epidata/fluview/?regions=nat&epiweeks=201453&issues=20150

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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).


Expand Down
4 changes: 2 additions & 2 deletions docs/api/fluview_clinical.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,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.txt) labels |
| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt) labels |

### Optional

Expand Down Expand Up @@ -94,7 +94,7 @@ https://delphi.cmu.edu/epidata/fluview_clinical/?regions=nat&epiweeks=202001

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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).

### JavaScript (in a web browser)
Expand Down
6 changes: 3 additions & 3 deletions docs/api/gft.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ General topics not specific to any particular endpoint are discussed in the
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/)
- Temporal Resolution: Weekly from 2003w40 until 2015w32
- Spatial Resolution: National, [HHS regions](http://www.hhs.gov/iea/regional/) ([1+10](../../labels/regions.txt)); by state/territory ([50+1](../../labels/states.txt)); and by city ([97](../../labels/cities.txt))
- 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

# The API
Expand All @@ -34,7 +34,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](../../labels/regions.txt)/[state](../../labels/states.txt)/[city](../../labels/cities.txt) labels |
| `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 |

## Response

Expand Down Expand Up @@ -69,7 +69,7 @@ https://delphi.cmu.edu/epidata/gft/?locations=nat&epiweeks=201501

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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).

### JavaScript (in a web browser)
Expand Down
2 changes: 1 addition & 1 deletion docs/api/ght.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,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](../../labels/states.txt) and/or `US` labels |
| `locations` | locations | `list` of [state](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/states.txt) and/or `US` labels |
| `query` | search query or topic ID (see https://www.freebase.com/) | string |

## Response
Expand Down
6 changes: 3 additions & 3 deletions docs/api/nidss_dengue.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ General topics not specific to any particular endpoint are discussed in the
Counts of confirmed dengue cases from Taiwan's 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](../../labels/nidss_regions.txt)) and by [city/county](https://en.wikipedia.org/wiki/List_of_administrative_divisions_of_Taiwan) ([22](../../labels/nidss_locations.txt))
- 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
Expand All @@ -34,7 +34,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](../../labels/nidss_regions.txt) and/or [location](../../labels/nidss_locations.txt) labels |
| `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 |

## Response

Expand Down Expand Up @@ -69,7 +69,7 @@ https://delphi.cmu.edu/epidata/nidss_dengue/?locations=nationwide&epiweeks=20150

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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).

### JavaScript (in a web browser)
Expand Down
6 changes: 3 additions & 3 deletions docs/api/nidss_flu.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ General topics not specific to any particular endpoint are discussed in the
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](../../labels/nidss_regions.txt))
- 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

\* Data is usually released on Tuesday
Expand All @@ -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](../../labels/nidss_regions.txt) labels |
| `regions` | regions | `list` of [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/nidss_regions.txt) labels |

### Optional

Expand Down Expand Up @@ -90,7 +90,7 @@ https://delphi.cmu.edu/epidata/nidss_flu/?regions=nationwide&epiweeks=201501

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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).

### JavaScript (in a web browser)
Expand Down
6 changes: 3 additions & 3 deletions docs/api/nowcast.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ General topics not specific to any particular endpoint are discussed in the
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](../../labels/regions.txt)), and by state/territory ([51](../../labels/states.txt))
- 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

\* Data is usually released on Friday and updated on Sunday and Monday
Expand All @@ -36,7 +36,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](../../labels/regions.txt)/[state](../../labels/states.txt) labels |
| `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 |

## Response

Expand Down Expand Up @@ -73,7 +73,7 @@ https://delphi.cmu.edu/epidata/nowcast/?locations=nat&epiweeks=202001

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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).

### JavaScript (in a web browser)
Expand Down
2 changes: 1 addition & 1 deletion docs/api/quidel.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,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 `hhs<#>` [region](../../labels/regions.txt) labels |
| `locations` | locations | `list` of `hhs<#>` [region](https://github.com/cmu-delphi/delphi-epidata/blob/main/labels/regions.txt) labels |

## Response

Expand Down
4 changes: 2 additions & 2 deletions docs/api/sensors.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,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](../../labels/regions.txt)/[state](../../labels/states.txt) labels <!-- TODO: check --> |
| `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 --> |
| `names` | sensor names | `list` of string |

Notes:
Expand Down Expand Up @@ -90,7 +90,7 @@ https://delphi.cmu.edu/epidata/sensors/?names=sar3&locations=nat&epiweeks=202001

# Code Samples

Libraries are available for [JavaScript](../../src/client/delphi_epidata.js), [Python](../../src/client/delphi_epidata.py), and [R](../../src/client/delphi_epidata.R).
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).

### JavaScript (in a web browser)
Expand Down
Loading