Skip to content

Commit a56cf2a

Browse files
committed
doc: consolidate changelogs in each source page under dropdown
1 parent 1aa259e commit a56cf2a

21 files changed

+363
-148
lines changed

docs/api/covidcast-signals/_source-template.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,7 @@ grand_parent: Main Endpoint (COVIDcast)
99

1010
* **Source name:** `SOURCE-API-NAME`
1111
* **Earliest issue available:** DATE RELEASED TO API
12-
* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#template))
13-
* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#template))
12+
* **Date of last data revision:** Never (see [data revision docs](#changelog))
1413
* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))
1514
* **Time type:** day (see [date format docs](../covidcast_times.md))
1615
* **License:** [LICENSE NAME](../covidcast_licensing.md#APPLICABLE-SECTION)
@@ -21,6 +20,15 @@ A brief description of what this source measures.
2120
|---------------|----------------------------------------------------------------------------------------------------------|
2221
| `signal_name` | Brief description of the signal, including the units it is measured in and any smoothing that is applied |
2322

23+
## Changelog
24+
25+
<details>
26+
<summary>Click to expand</summary>
27+
28+
Your collapsible content goes here. You can still use **Markdown** inside.
29+
30+
</details>
31+
2432
## Table of contents
2533
{: .no_toc .text-delta}
2634

docs/api/covidcast-signals/chng.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,22 @@ nav_order: 1
1010

1111
* **Source name:** `chng`
1212
* **Earliest issue available:** November 4, 2020
13-
* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#chng))
14-
* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#chng))
13+
* **Date of last data revision:** Never (see [data revision docs](#changelog))
1514
* **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md))
1615
* **Time type:** day (see [date format docs](../covidcast_times.md))
1716
* **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial)
1817

18+
## Changelog
19+
20+
<details>
21+
<summary>Click to expand</summary>
22+
23+
See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals.
24+
25+
No changes so far.
26+
27+
</details>
28+
1929
## Overview
2030

2131
**Notice: This data source was inactive between 2021-10-04 and 2021-12-02 to allow us resolve some problems with the data pipeline. We have resumed daily updates and are working on a data patch to fill the gap. [Additional details on this inactive period are available below](#pipeline-pause).**

docs/api/covidcast-signals/covid-act-now.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,24 @@ nav_order: 2
1010

1111
* **Source name:** `covid-act-now`
1212
* **Earliest issue available:** March 25, 2021
13-
* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#covid-act-now))
14-
* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#covid-act-now))
13+
* **Date of last data revision:** Never (see [data revision docs](#changelog))
1514
* **Available for:** county, hrr, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md))
1615
* **Time type:** day (see [date format docs](../covidcast_times.md))
1716
* **License:** [CC BY-NC](../covidcast_licensing.md#creative-commons-attribution-noncommercial)
1817

18+
## Changelog
19+
20+
<details>
21+
<summary>Click to expand</summary>
22+
23+
See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals.
24+
25+
No changes so far.
26+
27+
</details>
28+
29+
## Overview
30+
1931
The [COVID Act Now (CAN)](https://covidactnow.org/) data source provides COVID-19 testing statistics, such as positivity rates and total tests performed.
2032
The county-level positivity rates and test totals are pulled directly from CAN using [their API](https://covidactnow.org/data-api).
2133
While CAN provides this data potentially from multiple sources, we only use data that CAN sources from the

docs/api/covidcast-signals/covid-trends-and-impact-survey.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,41 @@ permalink: api/covidcast-signals/fb-survey.html
1111

1212
* **Source name:** `fb-survey`
1313
* **Earliest issue available:** April 29, 2020
14-
* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#fb-survey))
1514
* **Date of last data revision:** June 3, 2020 (see [data revision docs](../covidcast_changelog.md#fb-survey))
1615
* **Available for:** county, hrr, msa, state, nation (see [geography coding docs](../covidcast_geography.md))
1716
* **Time type:** day (see [date format docs](../covidcast_times.md))
1817
* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution)
1918

19+
## Changelog
20+
21+
<details>
22+
<summary>Click to expand</summary>
23+
24+
See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals.
25+
26+
### June 3, 2020
27+
28+
Duplicate survey weights had corrupted historical figures for the following signals and dates. The correct data has been restored to the API.
29+
* `raw_wcli`
30+
* `county`: 20200406, 20200408, 20200410, 20200430
31+
* `hrr`: 20200406, 20200408-20200410, 20200430
32+
* `msa`: 20200408, 20200410, 20200430
33+
* `state`: 20200408-20200410, 20200430
34+
* `smoothed_wcli`
35+
* `county`: 20200406, 20200408-20200414, 20200430-20200506
36+
* `hrr`: 20200406-20200415, 20200430-20200506
37+
* `msa`: 20200408-20200414, 20200430-20200506
38+
* `state`: 20200408-20200416, 20200430-20200506
39+
40+
### November 20, 2020
41+
42+
Due to a bug in our data processing system, estimates of the percentage of people reporting that they have been tested for COVID-19 calculated before October 8th were incorrect.
43+
We incorrectly treated an answer of “no” as a missing response, which affected the `smoothed_tested_14d` and `smoothed_wtested_14d` signals from the `fb-survey` source.
44+
45+
As of Nov. 20th, the error has been corrected and all affected data reissued.
46+
47+
</details>
48+
2049
## Overview
2150

2251
This data source is based on the [COVID-19 Trends and Impact Survey (CTIS)](../../symptom-survey/)

docs/api/covidcast-signals/doctor-visits.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,22 @@ nav_order: 1
1010

1111
* **Source name:** `doctor-visits`
1212
* **Earliest issue available:** April 29, 2020
13-
* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#doctor-visits))
14-
* **Date of last data revision:** November 9, 2020 (see [data revision docs](../covidcast_changelog.md#doctor-visits))
13+
* **Date of last data revision:** November 9, 2020 (see [data revision docs](#changelog))
1514
* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))
1615
* **Time type:** day (see [date format docs](../covidcast_times.md))
1716
* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution)
1817

18+
## Changelog
19+
20+
<details>
21+
<summary>Click to expand</summary>
22+
23+
See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals.
24+
25+
### November 9, 2020
26+
We went from a custom geo-mapping file (for aggregating from county->(msa, hrr, state)) to a central geo file based on rigorously sourced US census data.
27+
28+
</details>
1929

2030
## Overview
2131

docs/api/covidcast-signals/dsew-cpr.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,24 @@ nav_order: 2
1010

1111
* **Source name:** `dsew-cpr`
1212
* **Earliest issue available:** January 28, 2022
13-
* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#dsew-cpr))
14-
* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#dsew-cpr))
13+
* **Date of last data revision:** Never (see [data revision docs](#changelog))
1514
* **Available for:** county, msa, state, hhs, nation (see [geography coding docs](../covidcast_geography.md))
1615
* **Time type:** day (see [date format docs](../covidcast_times.md))
1716
* **License:** [Public Domain US Government](https://www.usa.gov/government-works)
1817

18+
## Changelog
19+
20+
<details>
21+
<summary>Click to expand</summary>
22+
23+
See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals.
24+
25+
No changes so far.
26+
27+
</details>
28+
29+
## Overview
30+
1931
The Community Profile Report (CPR) is published by the Data Strategy and Execution Workgroup (DSEW) of the White House COVID-19 Team. For more information, see the [official description at healthdata.gov](https://healthdata.gov/Health/COVID-19-Community-Profile-Report/gqxm-d9w9) for "COVID-19 Community Profile Report". Each issue of the CPR is made available as an attachment on that page. You can view all attachments by scrolling to the bottom of the "About this dataset" panel and clicking "Show more".
2032

2133
This data source provides various COVID-19 related metrics, of which we report hospital admissions and vaccinations.

docs/api/covidcast-signals/ght.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,21 @@ nav_order: 2
1010

1111
* **Source name:** `ght`
1212
* **Earliest issue available:** April 29, 2020
13-
* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#ght))
14-
* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#ght))
13+
* **Date of last data revision:** Never (see [data revision docs](#changelog))
1514
* **Available for:** dma, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))
1615
* **Time type:** day (see [date format docs](../covidcast_times.md))
1716

17+
## Changelog
18+
19+
<details>
20+
<summary>Click to expand</summary>
21+
22+
See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals.
23+
24+
No changes so far.
25+
26+
</details>
27+
1828
## Overview
1929

2030
This data source (`ght`) is based on Google searches, provided to us by Google

docs/api/covidcast-signals/google-survey.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,22 @@ nav_order: 2
1010

1111
* **Source name:** `google-survey`
1212
* **Earliest issue available:** May 01, 2020
13-
* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#google-survey))
14-
* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#google-survey))
13+
* **Date of last data revision:** Never (see [data revision docs](#changelog))
1514
* **Available for:** county, hrr, msa, state (see [geography coding docs](../covidcast_geography.md))
1615
* **Time type:** day (see [date format docs](../covidcast_times.md))
1716
* **License:** [CC BY](../covidcast_licensing.md#creative-commons-attribution)
1817

18+
## Changelog
19+
20+
<details>
21+
<summary>Click to expand</summary>
22+
23+
See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals.
24+
25+
No changes so far.
26+
27+
</details>
28+
1929
## Overview
2030

2131
Data source based on [Google-run symptom surveys](https://9to5google.com/2020/03/23/google-coronavirus-survey/), through publisher websites,

docs/api/covidcast-signals/google-symptoms.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ nav_order: 1
1010

1111
* **Source name:** `google-symptoms`
1212
* **Earliest issue available:** Aug 20, 2017
13-
* **Number of data revisions:** 1 (see [data revision docs](../covidcast_changelog.md#google-symptoms))
14-
* **Date of last data revision:** February 28, 2025 (see [data revision docs](../covidcast_changelog.md#google-symptoms))
13+
* **Date of last data revision:** March 14, 2025 (see [data revision docs](#changelog))
1514
* **Available for:** county, MSA, HRR, state, HHS, nation (see [geography coding docs](../covidcast_geography.md))
1615
* **Time type:** day (see [date format docs](../covidcast_times.md))
1716
* **License:** To download or use the data, you must agree to the Google [Terms of Service](https://policies.google.com/terms)

docs/api/covidcast-signals/hhs.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,24 @@ nav_order: 2
1010

1111
* **Source name:** `hhs`
1212
* **Earliest issue available:** November 16, 2020
13-
* **Number of data revisions:** 0 (see [data revision docs](../covidcast_changelog.md#hhs))
14-
* **Date of last data revision:** Never (see [data revision docs](../covidcast_changelog.md#hhs))
13+
* **Date of last data revision:** Never (see [data revision docs](#changelog))
1514
* **Available for:** state, hhs, nation (see [geography coding docs](../covidcast_geography.md))
1615
* **Time type:** day (see [date format docs](../covidcast_times.md))
1716
* **License:** [Public Domain US Government](https://www.usa.gov/government-works)
1817

18+
## Changelog
19+
20+
<details>
21+
<summary>Click to expand</summary>
22+
23+
See [COVIDcast Signal Changes](../covidcast_changelog.md) for general information about how we track changes to signals.
24+
25+
No changes so far.
26+
27+
</details>
28+
29+
## Overview
30+
1931
The U.S. Department of Health & Human Services (HHS) publishes several
2032
datasets on patient impact and hospital capacity. The data is made available
2133
to HHS through the CDC’s National Healthcare Safety Network (NHSN). One of these

0 commit comments

Comments
 (0)