Skip to content

Commit ab3184f

Browse files
committed
docs: update headers for Other Endpoints with epiportal information. The last update was included for inactive endpoints.
1 parent 8e3a3ff commit ab3184f

26 files changed

+150
-80
lines changed

docs/api/cdc.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ nav_order: 2
1515
| **Data Source** | CDC influenza surveillance data |
1616
| **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) |
18-
| **Update Frequency** | Inactive - No longer updated |
18+
| **Update Frequency** | Inactive - No longer updated since 2020w03 (2020-01-12) |
1919
| **Earliest Date** | 2013w02 (2013-01-06) |
2020

21-
<!-- | **License** | | -->
21+
<!-- | **License** | Permission by CDC flu division | -->
2222

2323
## Overview
2424
{: .no_toc}
@@ -37,7 +37,6 @@ General topics not specific to any particular endpoint are discussed in the
3737
{:toc}
3838

3939

40-
4140
# The API
4241

4342
The base URL is: <https://api.delphi.cmu.edu/epidata/cdc/>

docs/api/client_libraries.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -133,28 +133,28 @@ cat(paste(res$result, res$message, length(res$epidata), "\n"))
133133

134134
<div class="tab-content" data-tab="js" markdown="1">
135135

136-
The minimalist JavaScript client does not currently support API keys.
137-
If you need API key support in JavaScript, contact delphi-support+privacy@andrew.cmu.edu.
138-
139-
```html
140-
<script src="delphi_epidata.js"></script>
141-
<script>
142-
EpidataAsync.covidcast(
143-
"fb-survey",
144-
"smoothed_cli",
145-
"day",
146-
"county",
147-
[20200401, EpidataAsync.range(20200405, 20200414)],
148-
"06001"
149-
).then((res) => {
150-
console.log(
151-
res.result,
152-
res.message,
153-
res.epidata != null ? res.epidata.length : 0
154-
);
155-
});
156-
</script>
157-
```
136+
The minimalist JavaScript client does not currently support API keys.
137+
If you need API key support in JavaScript, contact delphi-support+privacy@andrew.cmu.edu.
138+
139+
```html
140+
<script src="delphi_epidata.js"></script>
141+
<script>
142+
EpidataAsync.covidcast(
143+
"fb-survey",
144+
"smoothed_cli",
145+
"day",
146+
"county",
147+
[20200401, EpidataAsync.range(20200405, 20200414)],
148+
"06001"
149+
).then((res) => {
150+
console.log(
151+
res.result,
152+
res.message,
153+
res.epidata != null ? res.epidata.length : 0
154+
);
155+
});
156+
</script>
157+
```
158158
</div>
159159

160160
</div>

docs/api/covid_hosp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ nav_order: 2
1515
| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) |
1616
| **Geographic Coverage** | US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) |
1717
| **Temporal Resolution** | Daily |
18-
| **Update Frequency** | Inactive - No longer updated |
18+
| **Update Frequency** | Inactive - No longer updated since 2024-04-27 |
1919
| **Earliest Date** | 2020-01-01 |
2020
| **License** | [Public Domain US Government](https://www.usa.gov/government-works) |
2121

docs/api/covid_hosp_facility.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ nav_order: 2
1515
| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) |
1616
| **Geographic Coverage** | Healthcare facility |
1717
| **Temporal Resolution** | Weekly (Friday -- Thursday) |
18-
| **Update Frequency** | Inactive - No longer updated |
18+
| **Update Frequency** | Inactive - No longer updated since 2024w08 |
1919
| **Earliest Date** | 2020-07-31 |
2020
| **License** | [Public Domain US Government](https://www.usa.gov/government-works) |
2121

@@ -62,7 +62,7 @@ See [this documentation](README.md) for details on specifying locations and date
6262

6363

6464
{: .note}
65-
> **NOTEs:**
65+
> **NOTES:**
6666
> - [`covid_hosp_facility_lookup` endpoint](covid_hosp_facility_lookup.md) can > be used to lookup facility identifiers in a variety of ways.
6767
> - A collection week spans Friday -- Thursday, and weeks are identified by
6868
> the date corresponding to the Friday at the start of the week. Therefore, the

docs/api/covid_hosp_facility_lookup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ nav_order: 2
1414
| **Source Name** | `covid_hosp_facility_lookup` |
1515
| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) |
1616
| **Geographic Coverage** | Healthcare facility ([state](geographic_codes.html#us-states-and-territories), ccn city, zip, fips) |
17-
| **Update Frequency** | Inactive - No longer updated |
17+
| **Update Frequency** | Inactive - No longer updated since 2024w08 |
1818
| **License** | [Public Domain US Government](https://www.usa.gov/government-works) |
1919

2020
<!-- | **Earliest Date** | N/A |

docs/api/delphi.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,10 @@ nav_order: 2
1515
| **Data Source** | [Delphi](https://delphi.cmu.edu/) |
1616
| **Temporal Resolution** | Weekly (Epiweek) |
1717
| **Systems available** | `af`, `eb`, `ec`, `sp`, `st` |
18-
| **Update Frequency** | Inactive - No longer updated |
18+
| **Update Frequency** | Inactive - No longer updated since 2020w19 |
19+
| **Earliest Date** | 2014w41 |
1920
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) |
2021

21-
<!--- | **Earliest Date** | 2014w41 | -->
22-
2322
## Overview
2423
{: .no_toc}
2524

docs/api/dengue_digital_surveillance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ permalink: api/dengue_sensors.html
1616
| **Data Source** | Various digital data streams |
1717
| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) <br> *Note: Data availability varies by country.* |
1818
| **Temporal Resolution** | Weekly (Epiweek) |
19-
| **Update Frequency** | Inactive - No longer updated |
20-
| **Earliest Date** | 2003w01 |
19+
| **Update Frequency** | Inactive - No longer updated since 2020w32|
20+
| **Earliest Date** | 2014w04 |
2121
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) |
2222

2323

docs/api/dengue_nowcast.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ nav_order: 2
1515
| **Data Source** | [Delphi](https://delphi.cmu.edu/) |
1616
| **Geographic Coverage** | Countries and territories in the Americas (see [Geographic Codes](geographic_codes.html#countries-and-territories-in-the-americas)) <br> *Note: Data availability varies by country.* |
1717
| **Temporal Resolution** | Weekly (Epiweek) |
18-
| **Update Frequency** | Inactive - No longer updated |
18+
| **Update Frequency** | Inactive - No longer updated since 2020w32 |
1919
| **Earliest Date** | 2014w09 |
20-
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/ |
20+
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) |
2121

2222

2323
## Overview

docs/api/digital_surveillance_sensors.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,10 @@ permalink: api/sensors.html
1515
| **Data Source** | Various digital data streams |
1616
| **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) |
18-
| **Update Frequency** | Inactive - No longer updated |
18+
| **Update Frequency** | Inactive - No longer updated since 2022w36 |
19+
| **Earliest Date** | 2010w40 |
1920
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) |
2021

21-
<!-- | **Earliest Date** | Variable | -->
22-
2322
This is the documentation of the API for accessing the Digital Surveillance Sensors (`sensors`) endpoint of
2423
the [Delphi](https://delphi.cmu.edu/)'s epidemiological data.
2524

@@ -29,7 +28,7 @@ General topics not specific to any particular endpoint are discussed in the
2928
[data licensing](README.md#data-licensing).
3029

3130
{: .note}
32-
> **Note:** this repository was built to support modelling and forecasting efforts
31+
> **Note:** This repository was built to support modelling and forecasting efforts
3332
> surrounding seasonal influenza (and dengue). In the current COVID-19 pandemic,
3433
> syndromic surveillance data, like ILI data (influenza-like illness) through
3534
> FluView, will likely prove very useful. However, **we urge caution to users

docs/api/ecdc_ili.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ nav_order: 2
1515
| **Data Source** | [European Centre for Disease Prevention and Control (ECDC)](https://www.ecdc.europa.eu/en/home) |
1616
| **Geographic Coverage** | European countries (see [Geographic Codes](geographic_codes.html#european-countries)) |
1717
| **Temporal Resolution** | Weekly (Epiweek) |
18-
| **Update Frequency** | Weekly |
18+
| **Update Frequency** | Inactive - No longer updated since 2020w12 |
1919
| **Earliest Date** | 2018w40 |
20-
| **License** | Open Access |
20+
| **License** | This was scraped from a publicly-accessible website, but no explicit license terms were found. |
2121

2222

2323
## Overview

0 commit comments

Comments
 (0)