Skip to content

Commit 029dc80

Browse files
JavierMtzRdzdsweber2
JavierMtzRdz
and
dsweber2
authored
Apply suggestions from David
Co-authored-by: David Weber <david.weber2@pm.me>
1 parent a0700cf commit 029dc80

3 files changed

Lines changed: 22 additions & 18 deletions

File tree

‎docs/api/v5-signals/epic-cosmos.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The `fill_method` column indicates how missing values were filled:
8989
| :--- | :--- |
9090
| `source` | Returns the raw reported value. |
9191
| `ave` | Fills missing values using the average of neighboring values during aggregation. |
92-
| `zero` | Treats suppressed or missing values as zero during aggregation. |
92+
| `zero` | Treats missing values as zero during aggregation. |
9393

9494
If you do not specify a `fill_method`, the API returns all available rows across all methods.
9595

‎docs/api/v5-signals/nwss.md‎

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,17 +53,18 @@ Wastewater signals are constructed by combining a pathogen prefix with a post-pr
5353

5454
### Pathogen Prefixes
5555

56-
| Prefix | Pathogen | Target PCR |
57-
|---|---|---|
58-
| `covid` | COVID-19 | SARS-CoV-2 |
59-
| `flu` | Influenza | Influenza A |
60-
| `flu_h5` | Avian Flu | H5 Influenza A |
61-
| `rsv` | RSV | Respiratory Syncytial Virus |
62-
| `measles` | Measles | Measles |
63-
| `mpox_all` | Mpox (All Clades) | Mpox (all clades) |
64-
| `mpox_clade_i` | Mpox Clade I | Mpox Clade I |
65-
| `mpox_clade_ii` | Mpox Clade II | Mpox Clade II |
66-
| `mpox_nvo` | Mpox NVO | Non-variola orthopoxvirus |
56+
| Prefix | Pathogen | Target PCR | Socrata endpoint |
57+
|---|---|---|---|
58+
| `covid` | COVID-19 | `sars-cov-2` | [j9g8-acpt](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-SARS-CoV-2/j9g8-acpt/about_data) |
59+
| `flu` | Influenza | `fluav` | [ymmh-divb](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-Influenza-A/ymmh-divb/about_data) |
60+
| `flu_h5` | Avian Flu | `fluav a h5` | [mtpu-urpp](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-H5-Influenza-A/mtpu-urpp/about_data) |
61+
| `rsv` | RSV | `rsv` | [45cq-cw4i](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-RSV/45cq-cw4i/about_data) |
62+
| `measles` | Measles | `mev_wt` | [akvg-8vrb](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-Measles/akvg-8vrb/about_data) |
63+
| `mpox_all` | Mpox (All Clades) | `hmpxv` | [xpxn-rzgz](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-Mpox/xpxn-rzgz/about_data) |
64+
| `mpox_clade_i` | Mpox Clade I | `hmpxv clade i` | [xpxn-rzgz](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-Mpox/xpxn-rzgz/about_data) |
65+
| `mpox_clade_ii` | Mpox Clade II | `hmpxv clade ii` | [xpxn-rzgz](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-Mpox/xpxn-rzgz/about_data) |
66+
| `mpox_nvo` | Mpox NVO | `nvo` | [xpxn-rzgz](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-Mpox/xpxn-rzgz/about_data) |
67+
6768

6869
### Suffixes
6970

@@ -74,6 +75,7 @@ Wastewater signals are constructed by combining a pathogen prefix with a post-pr
7475
| `flowpop_lin` | Flow-Population | Flow-population normalized concentration (copies/person/day) |
7576
| `mic_lin` | Microbial | Microbial normalized concentration (unitless ratio) |
7677

78+
For more details on the columns, see one of the socrata endpoints, e.g. [RSV](https://data.cdc.gov/Public-Health-Surveillance/CDC-Wastewater-Data-for-RSV/45cq-cw4i/about_data) which provides descriptions of all columns.
7779

7880
## Source-Specific Keys
7981

@@ -83,12 +85,12 @@ Wastewater data has unique properties, including multiple facilities, replicate
8385
|---|---|---|
8486
| `nwss_source` | Primary Key (Extra Key) | The data provider or laboratory network that analyzed/reported the sample (see [Providers](#providers)). |
8587
| `sample_index` | Primary Key (Extra Key) | An integer identifier mapped to the original sample's unique ID (`sample_id`). |
86-
| `pcr_target` | Value Column (Extra Value) | The target pathogen or organism analyzed in the sample (e.g., `sars-cov-2`, `fluav`, `rsv`). |
88+
| `pcr_target` | Value Column (Extra Value) | The target pathogen or organism analyzed in the sample (e.g., `sars-cov-2`, `fluav`, `rsv`). Include to join onto the auxiliary metadata table|
8789

8890

8991
## Auxiliary Metadata Table
9092

91-
Since wastewater treatment facilities have static traits (such as populations served and lab methodologies) that do not change daily, this metadata is served in a companion table via the `/aux_data/` endpoint at `https://delphi.cmu.edu/epidata/v5/aux_data/?source=nwss`.
93+
Since wastewater treatment facilities have sample-specific traits (such as populations served and lab methodologies) that can change with time, this metadata is served in a companion table via the `/aux_data/` endpoint at `https://delphi.cmu.edu/epidata/v5/aux_data/?source=nwss`.
9294

9395
The table is keyed by `report_time`, `geo_value`, `time_value`, `nwss_source`, `sample_index`, and `pcr_target`.
9496

@@ -107,7 +109,7 @@ The following table shows the history of data providers:
107109
|-|-|-|
108110
| `cdc_verily` | 2023/10/30-Today | Data analyzed by [Verily](https://verily.com/solutions/public-health/wastewater) on behalf of the CDC directly. |
109111
| `nwss` | 2020/06/21-Today | Data reported by the respective state, territorial, and local public health agencies; the actual processing may be done by a private lab such as Verily or Biobot, or the agency itself, or a partnering university. |
110-
| `wws` | 2021/12/26-Today | Data analyzed by [Wastewater Scan](https://www.wastewaterscan.org/en), a Stanford/Emory nonprofit, and then shared with the NWSS. |
112+
| `wws` | 2021/12/26-Today | Data analyzed by [Wastewater Scan](https://www.wastewaterscan.org/en), a Stanford/Emory nonprofit, and then shared with the NWSS. Use of this data outside of public health decision making requires contacting WastewaterSCAN Anyone seeking to use the database for other purposes or for research is required to contact the WastewaterSCAN / SCAN team (email: [wwscan_stanford_emory@lists.stanford.edu](mailto:wwscan_stanford_emory@lists.stanford.edu)) and any use of the data should be cited appropriately (https://data.wastewaterscan.org/about/#18).|
111113
| `biobot` | 2020-2023 | Data analyzed by [Biobot](https://biobot.io/) and then shared with the NWSS. |
112114

113115
### Normalization methods
@@ -165,5 +167,7 @@ The site-level data is provided un-versioned via the Socrata API across pathogen
165167

166168
The NWSS is aggregating data from [Verily](https://verily.com/solutions/public-health/wastewater), State Territorial and Local public health agencies, and [Wastewater Scan](https://www.wastewaterscan.org/en).
167169

170+
The WastewaterSCAN data were collected as part of the [WastewaterSCAN]([Wastewater Scan](https://www.wastewaterscan.org/en)) / SCAN project, a partnership between Stanford University, Emory University, and Verily funded philanthropically through a gift to Stanford University, and then shared with the NWSS. Anyone seeking to use the database for other purposes or for research is required to contact the WastewaterSCAN / SCAN team (email: [wwscan_stanford_emory@lists.stanford.edu](mailto:wwscan_stanford_emory@lists.stanford.edu)) and any use of the data should be cited appropriately (as described [here](https://data.wastewaterscan.org/about/#18)).
171+
168172
This data was originally published by the CDC, and is made available here as a convenience to the forecasting community under the terms of the original license, which is [U.S. Government Public Domain](https://www.usa.gov/government-copyright).
169173

‎docs/api/v5.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ nav_order: 2
66

77
# Delphi V5 API
88

9-
This is the documentation for accessing Delphi's epidemiological data streams via the new V5 API. Interactive, endpoint-level documentation is available on the [Delphi V5 API Landing Page](https://delphi.cmu.edu/epidata/v5/docs).
9+
This is the documentation for accessing Delphi's epidemiological data streams via the new V5 API. These pages focus on the properties of the data, whereas interactive, endpoint-level documentation is available on the [Delphi V5 API Landing Page](https://delphi.cmu.edu/epidata/v5/docs).
1010

1111
Many database and query patterns in the legacy API (the [COVIDcast endpoint](covidcast.md)) emerged from the rapid demands of the COVID-19 response. However, this legacy setup introduced critical bottlenecks. To address those limitations, the V5 API improves data quality, speeds up development times, and enhances query performance.
1212

13-
> **Get updates:** Delphi operates a [mailing list](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api) for users of the API. We will use this list to announce changes, corrections to data, and new features. We strongly encourage all users to subscribe.
13+
> **Get updates:** Delphi operates a [mailing list](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api) for users of the API. We will use this list to announce changes, corrections to data, and new features. We strongly encourage all users to subscribe. This is separate from signing up for an API key
1414
{: .important }
1515

1616
## Table of contents
@@ -45,7 +45,7 @@ For more information about how we use the data you provide us through your regis
4545

4646
Modern Delphi API clients (R [`epidatr`](https://cmu-delphi.github.io/epidatr/) and Python [`epidatpy`](https://cmu-delphi.github.io/epidatpy/)) support V5 queries natively. You can also explore and test endpoints interactively on the [Delphi V5 API Landing Page](https://delphi.cmu.edu/epidata/v5/docs).
4747

48-
## Core Data Sources
48+
## Current Data Sources
4949

5050
Please note that not all endpoints and sources from the legacy API have been migrated to the V5 API. The currently accessible sources are:
5151

0 commit comments

Comments
 (0)