Skip to content

Commit fd962e3

Browse files
authored
COVID reframing (#1754)
* docs: reframe intro away from COVID-centric language * docs: de-emphasize COVID in other-endpoints framing * docs: reframe COVIDcast guide beyond the pandemic * docs: fix nav parent refs after Other Endpoints rename * docs: reframe main endpoint intro beyond the pandemic * docs: include Jules' feedback on pandemic framing
1 parent 56f544d commit fd962e3

13 files changed

Lines changed: 32 additions & 32 deletions

docs/api/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: Other Endpoints (COVID-19 and Other Diseases)
2+
title: Other Endpoints
33
has_children: true
44
nav_order: 4
55
---
66

7-
# Other Endpoints (COVID-19 and Other Diseases)
7+
# Other Endpoints
88

99
This is the home of [Delphi](https://delphi.cmu.edu/)'s epidemiological data
10-
API for tracking epidemics such as influenza, dengue, and norovirus. Note that
11-
additional data, including most COVID-19 signals, is available in the
12-
[main Epidata API (formerly known as COVIDcast)](covidcast.md).
10+
API for tracking infectious diseases such as influenza, dengue,
11+
and norovirus. Note that additional data, including most COVID-19 signals, is
12+
available in the [main Epidata API (formerly known as COVIDcast)](covidcast.md).
1313

1414
## Table of Contents
1515
{: .no_toc .text-delta}

docs/api/covidcast.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,18 @@ nav_order: 3
66

77
# Main Epidata API
88

9-
This endpoint was previously known as COVIDcast.
9+
This legacy Epidata API endpoint was formerly called COVIDcast.
1010

11-
This is the documentation for accessing Delphi's COVID-19 indicators via the `covidcast` endpoint of [Delphi](https://delphi.cmu.edu/)'s
12-
epidemiological data API. This API provides data on the spread and impact of the COVID-19 pandemic across the United States, most of which is available at the
11+
This is the documentation for accessing all Delphi's indicators via the `covidcast` endpoint of [Delphi](https://delphi.cmu.edu/)'s
12+
epidemiological data API. This API provides data on the spread and impact of infectious diseases, including COVID-19, across the United States, most of which is available at the
1313
county level and updated daily. This data powers our public [COVIDcast
1414
map](https://delphi.cmu.edu/covidcast/) which includes testing, cases, and death data,
1515
as well as unique healthcare and survey data Delphi acquires through its
16-
partners. The API allows users to select specific signals and download data for
17-
selected geographical areas---counties, states, metropolitan statistical areas,
18-
and other divisions.
16+
partners. Many additional data sources and pathogen indicator types are available. The API allows users to select specific signals and download data for
17+
selected geographical areas. For a comprehensive look at the sources, signals, and geographic regions available through the API, please visit [EpiPortal](https://delphi.cmu.edu/epiportal/?hosted_by_delphi=on).
1918

2019

21-
> **Get updates:** Delphi operates a [mailing list](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api) for users of the COVIDcast API. We will use the list to announce API changes, corrections to data, and new features; API users may also use the mailing list to ask general questions about its use. If you use the API, we strongly encourage you to [subscribe](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api).
20+
> **Get updates:** Delphi operates a [mailing list](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api) for users of the main Epidata API. We will use the list to announce API changes, corrections to data, and new features; API users may also use the mailing list to ask general questions about its use. If you use the API, we strongly encourage you to [subscribe](https://lists.andrew.cmu.edu/mailman/listinfo/delphi-covidcast-api).
2221
{: .important }
2322

2423
## Table of contents
@@ -28,7 +27,7 @@ and other divisions.
2827
{:toc}
2928

3029
## Licensing
31-
Like all other Delphi Epidata datasets, our COVIDcast data is freely available to the public. However, our COVID-19 indicators include data from many different sources, with data licensing handled separately for each source. For a summary of the licenses used and a list of the indicators each license applies to, we suggest users visit our [COVIDcast licensing](covidcast_licensing.md) page. Licensing information is also summarized on each indicator's details page.
30+
Like all other Delphi Epidata datasets, our data is freely available to the public. However, our indicators include data from many different sources, with data licensing handled separately for each source. For a summary of the licenses used and a list of the indicators each license applies to, we suggest users visit our [licensing](covidcast_licensing.md) page. Licensing information is also summarized on each indicator's details page.
3231
We encourage academic users to [cite](README.md#citing) the data if they
3332
use it in any publications. Our [data ingestion
3433
code](https://github.com/cmu-delphi/covidcast-indicators) and [API server
@@ -39,9 +38,9 @@ in the [API overview](README.md).
3938
## Accessing the Data
4039

4140
Our [COVIDcast site](https://delphi.cmu.edu/covidcast/) provides an interactive
42-
visualization of a select set of the data signals available in the COVIDcast
43-
API, and provides a data export feature to download any data range as a
44-
CSV file.
41+
visualization of a select set of the data signals available and relevant
42+
during the COVID-19 pandemic, and provides a data export feature to download
43+
any data range as a CSV file.
4544

4645
Several [API clients are available](covidcast_clients.md) for common programming
4746
languages, so you do not need to construct API calls yourself to obtain
@@ -93,13 +92,13 @@ Alternatively, users can [manually construct URLs and parse responses to access
9392
The API provides multiple data sources, each with several signals. Each source
9493
represents one provider of data, such as a medical testing provider or a symptom
9594
survey, and each signal represents one quantity computed from data provided by
96-
that source. Our sources provide detailed data about COVID-related topics,
95+
that source. Our sources provide detailed data about infectious disease related topics,
9796
including confirmed cases, symptom-related search queries, hospitalizations,
9897
outpatient doctor's visits, and other sources. Many of these are publicly
99-
available *only* through the COVIDcast API.
98+
available *only* through the main Epidata API.
10099

101-
Delphi's COVID-19 indicators data includes the following data sources.
102-
Data from most of these sources is typically updated daily. You can use the
100+
Update cadence varies by source, reflecting what is most relevant for each
101+
pathogen and context. You can use the
103102
[`covidcast_meta`](covidcast_meta.md) endpoint to get summary information
104103
about the ranges of the different attributes for the different data sources.
105104

docs/api/date_formats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Date Formats
3-
parent: Other Endpoints (COVID-19 and Other Diseases)
3+
parent: Other Endpoints
44
nav_order: 901
55
---
66

docs/api/epidata_signals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Data Sources and Signals
3-
parent: Other Endpoints (COVID-19 and Other Diseases)
3+
parent: Other Endpoints
44
nav_order: 2
55
has_children: true
66

docs/api/flusurv.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Flusurv
33
parent: Data Sources and Signals
4-
grand_parent: Other Endpoints (COVID-19 and Other Diseases)
4+
grand_parent: Other Endpoints
55
nav_order: 3
66
---
77

docs/api/fluview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FluView
33
parent: Data Sources and Signals
4-
grand_parent: Other Endpoints (COVID-19 and Other Diseases)
4+
grand_parent: Other Endpoints
55
nav_order: 1
66
---
77

docs/api/fluview_clinical.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FluView Clinical
33
parent: Data Sources and Signals
4-
grand_parent: Other Endpoints (COVID-19 and Other Diseases)
4+
grand_parent: Other Endpoints
55
nav_order: 2
66
---
77

docs/api/fluview_meta.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FluView Metadata
33
parent: Data Sources and Signals
4-
grand_parent: Other Endpoints (COVID-19 and Other Diseases)
4+
grand_parent: Other Endpoints
55
nav_order: 1
66
---
77

docs/api/geographic_codes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Geographic Codes
3-
parent: Other Endpoints (COVID-19 and Other Diseases)
3+
parent: Other Endpoints
44
nav_order: 900
55
---
66

docs/api/inactive_other.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Inactive Sources (Other)
33
parent: Data Sources and Signals
4-
grand_parent: Other Endpoints (COVID-19 and Other Diseases)
4+
grand_parent: Other Endpoints
55
nav_order: 99
66
has_children: true
77
---

0 commit comments

Comments
 (0)