WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit d6122aa

Browse files
committed
docs: fix headers to align with epiportal categories in other endpoints and indicate date formats
1 parent 5a45d6f commit d6122aa

29 files changed

+219
-164
lines changed

docs/api/01meta.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,13 @@ General topics not specific to any particular endpoint are discussed in the
1818

1919
## API Metadata
2020

21-
... <!-- TODO -->
21+
Overview of the current state of the database, including the latest update times and data volume for specific endpoints.
2222

2323
# The API
2424

2525
The base URL is: <https://api.delphi.cmu.edu/epidata/meta/>
2626

27-
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
27+
See [this documentation](date_formats.html) for details on specifying epiweeks, dates, and lists.
2828

2929
## Parameters
3030

@@ -36,7 +36,10 @@ None.
3636
|-----------|-----------------------------------------------------------------|------------------|
3737
| `result` | result code: 1 = success, 2 = too many results, -2 = no results | integer |
3838
| `epidata` | list of results | array of objects |
39-
| ... | ... | ... | <!-- TODO -->
39+
| `epidata[].fluview` | Metadata for [FluView](fluview.md) | array of objects |
40+
| `epidata[].twitter` | Metadata for [Twitter](twitter.md) | array of objects |
41+
| `epidata[].wiki` | Metadata for [Wikipedia](wiki.md) | array of objects |
42+
| `epidata[].delphi` | Metadata for [Delphi Forecasts](delphi.md) | array of objects |
4043
| `message` | `success` or error message | string |
4144

4245
# Example URLs

docs/api/README.md

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -75,19 +75,12 @@ The base URL is: <https://api.delphi.cmu.edu/epidata/>
7575

7676
## Specifying Epiweeks, Dates, and Lists
7777

78-
Epiweeks use the U.S. definition. That is, the first epiweek each year is the
79-
week, starting on a Sunday, containing January 4. See
80-
[this page](https://www.cmmcp.org/mosquito-surveillance-data/pages/epi-week-calendars-2008-2020)
81-
for more information.
82-
8378
Formatting for epiweeks is YYYYWW and for dates is YYYYMMDD.
8479

85-
`list` parameters consist of a comma-separated list of individual values or, for numeric parameters, a hyphenated range of values. Examples include:
86-
- `param=201530` *(A single epiweek)*
87-
- `param=201401,201501,201601` *(Several epiweeks)*
88-
- `param=200501-200552` *(A range of epiweeks)*
89-
- `param=201440,201501-201510` *(Several epiweeks, including a range)*
90-
- `param=20070101-20071231` *(A range of dates)*
80+
See [Date Formats](date_formats.html) for full details on specifying epiweeks, dates, lists, and ranges.
81+
82+
`list` parameters consist of a comma-separated list of individual values or, for numeric parameters, a hyphenated range of values.
83+
9184

9285
## Universal Parameters
9386

@@ -111,8 +104,8 @@ The parameters available for each source are documented in each linked source-sp
111104

112105
| Endpoint | Name | Description | Restricted? |
113106
| --- | --- | --- | --- |
114-
| [`cdc`](cdc.md) | CDC Page Hits | ... <!-- TODO --> | yes |
115-
| [`delphi`](delphi.md) | Delphi's Forecast | ... <!-- TODO --> | no |
107+
| [`cdc`](cdc.md) | CDC Page Hits | CDC total and by topic webpage visits. | yes |
108+
| [`delphi`](delphi.md) | Delphi's Forecast | Delphi's ILINet outpatient doctor visits forecasts. | no |
116109
| [`ecdc_ili`](ecdc_ili.md) | ECDC ILI | ECDC ILI data from the ECDC website. | no |
117110
| [`flusurv`](flusurv.md) | FluSurv | FluSurv-NET data (flu hospitaliation rates) from CDC. | no |
118111
| [`fluview`](fluview.md) | FluView | Influenza-like illness (ILI) from U.S. Outpatient Influenza-like Illness Surveillance Network (ILINet). | no |
@@ -125,25 +118,25 @@ The parameters available for each source are documented in each linked source-sp
125118
| [`nidss_flu`](nidss_flu.md) | NIDSS Flu | Outpatient ILI from Taiwan's National Infectious Disease Statistics System (NIDSS). | no |
126119
| [`nowcast`](nowcast.md) | ILI Nearby | A nowcast of U.S. national, regional, and state-level (weighted) percent ILI, available seven days (regionally) or five days (state-level) before the first ILINet report for the corresponding week. | no |
127120
| [`quidel`](quidel.md) | Quidel | Data provided by Quidel Corp., which contains flu lab test results. | yes |
128-
| [`sensors`](sensors.md) | Delphi's Digital Surveillance Sensors | Digital surveillance signals for influenza. | no |
121+
| [`sensors`](sensors.html) | Delphi's Digital Surveillance Sensors | Influenza and dengue digital surveillance sensors. | partially |
129122
| [`twitter`](twitter.md) | Twitter Stream | Estimate of influenza activity based on analysis of language used in tweets from [HealthTweets](http://HealthTweets.org/). | yes |
130123
| [`wiki`](wiki.md) | Wikipedia Access Logs | Number of page visits for selected English, Influenza-related wikipedia articles. | no |
131124

132125
### Dengue Data
133126

134127
| Endpoint | Name | Description | Restricted? |
135128
| --- | --- | --- | --- |
136-
| [`dengue_nowcast`](dengue_nowcast.md) | Delphi's Dengue Nowcast | Nowcast of dengue in Puerto Rico and other regions. |... <!-- TODO --> |
137-
| [`dengue_sensors`](dengue_sensors.md) | Delphi's Dengue Digital Surveillance Sensors | Digital surveillance signals for dengue. | ... <!-- TODO --> |
138-
| [`nidss_dengue`](nidss_dengue.md) | NIDSS Dengue | Counts of confirmed dengue cases from Taiwan's NIDSS. | no |
139-
| [`paho_dengue`](paho_dengue.md) | PAHO Dengue | Dengue cases reported by PAHO. | ... <!-- TODO --> |
129+
| [`dengue_nowcast`](dengue_nowcast.md) | Delphi's Dengue Nowcast | Delphi's PAHO dengue nowcasts (North and South America). | no |
130+
| [`dengue_sensors`](dengue_sensors.md) | Delphi's Dengue Digital Surveillance Sensors | PAHO dengue digital surveillance sensors (North and South America). | yes |
131+
| [`nidss_dengue`](nidss_dengue.md) | NIDSS Dengue | NIDSS dengue cases (Taiwan). | no |
132+
| [`paho_dengue`](paho_dengue.md) | PAHO Dengue | PAHO dengue data (North and South America). | no |
140133

141134
### Norovirus Data
142135

143136
| Endpoint | Name | Description | Restricted? |
144137
| --- | --- | --- | --- |
145-
| [`meta_norostat`](meta_norostat.md) | NoroSTAT Metadata | Metadata for NoroSTAT data. | ... <!-- TODO --> |
146-
| [`norostat`](norostat.md) | NoroSTAT | Suspected and confirmed norovirus outbreaks reported by state health departments to the CDC. | ... <!-- TODO --> |
138+
| [`meta_norostat`](meta_norostat.md) | NoroSTAT Metadata | Metadata for the NoroSTAT endpoint. | yes |
139+
| [`norostat`](norostat.md) | NoroSTAT | CDC NoroSTAT norovirus outbreaks. | yes |
147140

148141
### Deprecated
149142
* `ilinet` - replaced by [`fluview`](fluview.md)

docs/api/cdc.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ 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 (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) |
17-
| **Temporal Resolution** | Weekly (Epiweek) |
18-
| **Update Frequency** | Inactive - No longer updated since 2020w03 (2020-01-12) |
19-
| **Earliest Date** | 2013w02 (2013-01-06) |
16+
| **Geographic Levels** | National, HHS regions, Census divisions, and US states (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) |
17+
| **Temporal Granularity** | Weekly (Epiweek) |
18+
| **Reporting Cadence** | Inactive - No longer updated since 2020w03 (2020-01-12) |
19+
| **Temporal Scope Start** | 2013w02 (2013-01-06) |
2020

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

@@ -41,7 +41,6 @@ General topics not specific to any particular endpoint are discussed in the
4141

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

44-
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
4544

4645
## Parameters
4746

@@ -50,7 +49,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
5049
| Parameter | Description | Type |
5150
| --- | --- | --- |
5251
| `auth` | password | string |
53-
| `epiweeks` | epiweeks | `list` of epiweeks |
52+
| `epiweeks` | epiweeks (see [Date Formats](date_formats.html)) | `list` of epiweeks |
5453
| `locations` | locations | `list` of location codes: `nat` (national), HHS regions (`hhs1`-`hhs10`), Census divisions (`cen1`-`cen9`), or state codes (see [Geographic Codes](geographic_codes.html#us-regions-and-states)) |
5554

5655
## Response

docs/api/covid_hosp.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ nav_order: 2
1313
| :--- | :--- |
1414
| **Source Name** | `covid_hosp_state_timeseries` |
1515
| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/g62h-syeh) |
16-
| **Geographic Coverage** | US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) |
17-
| **Temporal Resolution** | Daily |
18-
| **Update Frequency** | Inactive - No longer updated since 2024-04-27 |
19-
| **Earliest Date** | 2020-01-01 |
16+
| **Geographic Levels** | US States plus DC, PR, and VI (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) |
17+
| **Temporal Granularity** | Daily |
18+
| **Reporting Cadence** | Inactive - No longer updated since 2024-04-27 |
19+
| **Temporal Scope Start** | 2020-01-01 |
2020
| **License** | [Public Domain US Government](https://www.usa.gov/government-works) |
2121

2222
## Overview
@@ -55,7 +55,6 @@ General topics not specific to any particular data source are discussed in the
5555

5656
The base URL is: <https://api.delphi.cmu.edu/epidata/covid_hosp_state_timeseries/>
5757

58-
See [this documentation](README.md) for details on specifying locations and dates.
5958

6059
## Parameters
6160

@@ -64,13 +63,13 @@ See [this documentation](README.md) for details on specifying locations and date
6463
| Parameter | Description | Type |
6564
|-----------|--------------------------------|--------------------------------|
6665
| `states` | two-letter state abbreviations (see [Geographic Codes](geographic_codes.html#us-states-and-territories)) | `list` of states |
67-
| `dates` | dates | `list` of dates or date ranges |
66+
| `dates` | dates (see [Date Formats](date_formats.md)) | `list` of dates or date ranges |
6867

6968
### Optional
7069

7170
| Parameter | Description | Type |
7271
|-----------|-------------|----------------------------------------|
73-
| `issues` | issues | `list` of "issue" dates or date ranges |
72+
| `issues` | issues (see [Date Formats](date_formats.md)) | `list` of "issue" dates or date ranges |
7473

7574
If `issues` is not specified, then the most recent issue is used by default.
7675

docs/api/covid_hosp_facility.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ nav_order: 2
1313
| :--- | :--- |
1414
| **Source Name** | `covid_hosp_facility` |
1515
| **Data Source** | [US Department of Health & Human Services](https://healthdata.gov/Hospital/COVID-19-Reported-Patient-Impact-and-Hospital-Capa/anag-cw7u) |
16-
| **Geographic Coverage** | Healthcare facility |
17-
| **Temporal Resolution** | Weekly (Friday -- Thursday) |
18-
| **Update Frequency** | Inactive - No longer updated since 2024w08 |
19-
| **Earliest Date** | 2020-07-31 |
16+
| **Geographic Levels** | Healthcare facility |
17+
| **Temporal Granularity** | Weekly (Friday -- Thursday) |
18+
| **Reporting Cadence** | Inactive - No longer updated since 2024w08 |
19+
| **Temporal Scope Start** | 2020-07-31 |
2020
| **License** | [Public Domain US Government](https://www.usa.gov/government-works) |
2121

2222
## Overview

docs/api/covid_hosp_facility_lookup.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ nav_order: 2
1313
| :--- | :--- |
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) |
16-
| **Geographic Coverage** | Healthcare facility ([state](geographic_codes.html#us-states-and-territories), ccn city, zip, fips) |
17-
| **Update Frequency** | Inactive - No longer updated since 2024w08 |
16+
| **Geographic Levels** | Healthcare facility ([state](geographic_codes.html#us-states-and-territories), ccn city, zip, fips) |
17+
| **Reporting Cadence** | Inactive - No longer updated since 2024w08 |
1818
| **License** | [Public Domain US Government](https://www.usa.gov/government-works) |
1919

20-
<!-- | **Earliest Date** | N/A |
21-
| **Temporal Resolution** | N/A -->
20+
<!-- | **Temporal Scope Start** | N/A |
21+
| **Temporal Granularity** | N/A -->
2222

2323
## Overview
2424
{: .no_toc}

docs/api/covidcast_meta.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ geographic levels at which they are reported.
1616

1717
The base URL is: <https://api.delphi.cmu.edu/epidata/covidcast_meta/>
1818

19-
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
2019

2120
### Parameters
2221

docs/api/covidcast_times.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The available time types include:
3939
* `week`: A weekly observation, recording events over 7 days. The `time_value`
4040
and `issue` are reported with a year and a week number ranging from 1 to 53,
4141
in `YYYYWW` format. These weeks are [MMWR
42-
weeks](https://wwwn.cdc.gov/nndss/document/MMWR_Week_overview.pdf) as defined
42+
weeks](https://ndc.services.cdc.gov/wp-content/uploads/MMWR_week_overview.pdf) as defined
4343
by the National Notifiable Diseases Surveillance System, also known as
4444
"epiweeks". (The [API clients](covidcast_clients.md) convert these into date
4545
objects representing the first day of the MMWR week, and for those not using

docs/api/date_formats.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
title: Date Formats
3+
parent: Other Endpoints (COVID-19 and Other Diseases)
4+
nav_order: 101
5+
---
6+
7+
# Date Formats
8+
{: .no_toc}
9+
10+
This page documents the valid date and time formats accepted by various API endpoints.
11+
12+
## Table of contents
13+
{: .no_toc .text-delta}
14+
15+
1. TOC
16+
{:toc}
17+
18+
## Epiweeks
19+
20+
Epiweeks (Epidemiological Weeks) use the [U.S. CDC definition](https://ndc.services.cdc.gov/wp-content/uploads/MMWR_week_overview.pdf). That is, the first epiweek each year is the week, starting on a Sunday, containing January 4.
21+
22+
**Format:** `YYYYWW`
23+
* `YYYY`: Four-digit year
24+
* `WW`: Two-digit week (01-53)
25+
26+
Example: `201501` represents the first epiweek of 2015.
27+
28+
See [this page](https://www.cmmcp.org/mosquito-surveillance-data/pages/epi-week-calendars-2008-2020) for more information and calendars.
29+
30+
## Dates
31+
32+
Dates generally follow the ISO 8601 basic format, but without hyphens.
33+
34+
**Format:** `YYYYMMDD`
35+
* `YYYY`: Four-digit year
36+
* `MM`: Two-digit month (01-12)
37+
* `DD`: Two-digit day (01-31)
38+
39+
Example: `20150201` represents February 1st, 2015.
40+
41+
## Specifying Lists and Ranges
42+
43+
Many API parameters accept lists of values or ranges.
44+
45+
`list` parameters consist of a comma-separated list of individual values or, for numeric parameters (like epiweeks or dates), a hyphenated range of values.
46+
47+
**Examples:**
48+
49+
* **Single Value:** `param=201530`
50+
* **List of Values:** `param=201401,201501,201601`
51+
* **Range:** `param=200501-200552`
52+
* **Mixed List and Range:** `param=201440,201501-201510`
53+
* **Date Range:** `param=20070101-20071231`

docs/api/delphi.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ nav_order: 2
1313
| :--- | :--- |
1414
| **Source Name** | `delphi` |
1515
| **Data Source** | [Delphi](https://delphi.cmu.edu/) |
16-
| **Temporal Resolution** | Weekly (Epiweek) |
17-
| **Systems available** | `af`, `eb`, `ec`, `sp`, `st` |
18-
| **Update Frequency** | Inactive - No longer updated since 2020w19 |
19-
| **Earliest Date** | 2014w41 |
16+
| **Temporal Granularity** | Weekly (Epiweek) |
17+
| **Systems available** | `af`, `eb`, `ec`, `sp`, `st` (see [details below](#forecasting-systems)) |
18+
| **Reporting Cadence** | Inactive - No longer updated since 2020w19 |
19+
| **Temporal Scope Start** | Varies by system (earliest 2014w41) |
2020
| **License** | [CC BY](https://creativecommons.org/licenses/by/4.0/) |
2121

2222
## Overview
@@ -29,6 +29,19 @@ General topics not specific to any particular endpoint are discussed in the
2929
[contributing](README.md#contributing), [citing](README.md#citing), and
3030
[data licensing](README.md#data-licensing).
3131

32+
### Forecasting Systems
33+
34+
The following systems are available, representing different forecasting models for ILINet % weighted ILI:
35+
36+
| Code | Name |
37+
| :--- | :--- |
38+
| `af` | [Archefilter](http://reports-archive.adm.cs.cmu.edu/anon/cbd/CMU-CB-16-101.pdf#Appendix.1.B) |
39+
| `eb` | [Empirical Bayes](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1004382) |
40+
| `ec` | [Epicast](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005248) |
41+
| `sp` | [Pinned Spline](http://reports-archive.adm.cs.cmu.edu/anon/cbd/CMU-CB-16-101.pdf#Appendix.1.A) |
42+
| `st` | [Delphi-Stat](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1006134)
43+
44+
3245
## Table of contents
3346
{: .no_toc .text-delta}
3447

@@ -39,7 +52,6 @@ General topics not specific to any particular endpoint are discussed in the
3952

4053
The base URL is: <https://api.delphi.cmu.edu/epidata/delphi/>
4154

42-
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
4355

4456
## Parameters
4557

@@ -48,7 +60,7 @@ See [this documentation](README.md) for details on specifying epiweeks, dates, a
4860
| Parameter | Description | Type |
4961
|-----------|-------------|--------------------------------------|
5062
| `system` | system | system name (`af`, `eb`, `ec`, `sp`, `st`) |
51-
| `epiweek` | epiweek | epiweek when forecast was made |
63+
| `epiweek` | epiweek (see [Date Formats](date_formats.html)) | epiweek when forecast was made |
5264

5365
## Response
5466

0 commit comments

Comments
 (0)