Skip to content

Commit d1b83ac

Browse files
committed
Make a variety of small survey documentation improvements
1 parent acab711 commit d1b83ac

File tree

6 files changed

+29
-9
lines changed

6 files changed

+29
-9
lines changed

docs/symptom-survey/coding.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,11 @@ reported.)
6565
Invalid ZIP codes are preserved unchanged, and these rows are reported in the
6666
individual response files with their invalid ZIPs.
6767

68+
Additionally, beginning in wave 4, items D6 and D7 ask respondents for race and
69+
ethnicity. These columns are **not** available in the microdata files due to
70+
reidentification concerns. However, contingency tables that aggregate by race
71+
and other demographic variables [are available](contingency-tables.md).
72+
6873
## Wave 1
6974

7075
Wave 1 was first deployed on April 6, 2020. This was replaced by Wave 2, but

docs/symptom-survey/collaboration-revision.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ pandemic. We conduct revisions in collaboration with data users, fellow
1212
researchers, and public health officials, to ensure the survey data best serves
1313
public health and research goals.
1414

15-
### Current Data Use Survey
15+
## Current Data Use Survey
1616

1717
To allow us to better collaborate with our academic and non-profit research
1818
partners, we ask that you complete [this short
@@ -27,7 +27,7 @@ alleviate some response burden by eliminating unused questions, and allow us to
2727
connect with current data users regarding their research interests and areas of
2828
expertise.
2929

30-
### Proposing Revisions
30+
## Proposing Revisions
3131

3232
If there is a revision or question you would like us to consider, please fill
3333
out [this form requesting details about your

docs/symptom-survey/contingency-tables.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ for the survey is available, but only to academic or nonprofit researchers who
2222
sign a Data Use Agreement, whereas these contingency tables are available to the
2323
general public.
2424

25+
Please see our survey [credits](index.md#credits) and [citation information](index.md#citing-the-survey)
26+
for information on how to cite this data if you use it in a publication.
27+
2528
Important updates for data users, including corrections to data or updates on
2629
data processing delays, are posted as `OUTAGES.txt` in the directory where the
2730
data is hosted.
@@ -45,7 +48,7 @@ lower missingness when grouping by several features at a time.
4548
The included files provide estimates for various metrics of interest over a
4649
period of either a full epiweek (or [MMWR
4750
week](https://wwwn.cdc.gov/nndss/document/MMWR_week_overview.pdf), a
48-
standardized numbering of weeks throughout the year) or a full month.
51+
standardized numbering of weeks throughout the year) or a full calendar month.
4952

5053
## Aggregation
5154

@@ -94,6 +97,10 @@ The files contain [weighted estimates](../api/covidcast-signals/fb-survey.md#sur
9497
respondents who fulfill one or several criteria. Estimates are broken out by
9598
state, age, gender, race, and ethnicity.
9699

100+
We plan to expand this list of indicators based on research needs; if you have a
101+
public health or research need for a particular variable not listed here, please
102+
contact us at <delphi-survey-info@lists.andrew.cmu.edu>.
103+
97104
| Indicator | Description | Survey Item |
98105
| --- | --- | --- |
99106
| `pct_vaccinated` | Estimated percentage of respondents who have already received a COVID vaccine. <br/> **Earliest date available:** 2021-01-01 | V1 |

docs/symptom-survey/data-access.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,11 @@ spread of COVID-19 and its effects on public health and well-being. This may
1212
help improve our local and national responses to the pandemic and our
1313
understanding of how it has affected society.
1414

15+
[High-level aggregates](../api/covidcast.md) of select survey items are
16+
publicly available in the [COVIDcast API](../api/covidcast-signals/fb-survey.md).
17+
[Finer aggregates](./contingency-tables.md) grouped by various demographic
18+
characteristics are available for download.
19+
1520
De-identified individual survey responses can be made available to researchers associated with
1621
universities or non-profit organizations. To request access to the data please
1722
submit the information requested in [Facebook's page on obtaining data
@@ -21,7 +26,10 @@ which sets out the basic conditions and provides a form to request access. An
2126
is conducted by the University of Maryland (UMD) and access can be requested
2227
through the same form.
2328

24-
[High-level aggregates](../api/covidcast.md) of select survey items are
25-
publicly available in the [COVIDcast API](../api/covidcast-signals/fb-survey.md).
26-
[Finer aggregates](./contingency-tables.md) grouped by various demographic
27-
characteristics are available for download.
29+
After completing the form, staff from Facebook and CMU will be in contact to
30+
guide you through the rest of the process. They will provide data use agreements
31+
for your institution to sign, and will also request a copy of your Institutional
32+
Review Board approval to verify you have ethical approval to conduct the
33+
research. If you have questions about the process, or your IRB needs information
34+
about the survey for their review, contact us at
35+
<delphi-survey-info@lists.andrew.cmu.edu>.

docs/symptom-survey/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ the survey in publications based on the data. Specifically, we ask that you:
5959
2. Cite this web page for details about the survey. For example, you may cite it
6060
as
6161

62-
> Delphi Group (2020). COVID Symptom Survey.
62+
> Delphi Group (2021). COVID Symptom Survey.
6363
> <https://cmu-delphi.github.io/delphi-epidata/symptom-survey/>
6464
6565
A journal article describing the survey and its methods is currently in

docs/symptom-survey/problems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ nav_order: 7
55
---
66

77
# Problems and Data Errors
8-
{: no_toc}
8+
{: .no_toc}
99

1010
Given the scale of the COVID Symptom Survey, we occasionally encounter data
1111
errors or survey implementation problems that affect the interpretation of

0 commit comments

Comments
 (0)