Merge pull request #435 from cmu-delphi/docs/survey-clarifications

Make a variety of small survey documentation improvements

Author: capnrefsmmat

docs/symptom-survey/coding.md

@@ -65,6 +65,11 @@ reported.)
 Invalid ZIP codes are preserved unchanged, and these rows are reported in the
 individual response files with their invalid ZIPs.
 
+Additionally, beginning in wave 4, items D6 and D7 ask respondents for race and
+ethnicity. These columns are **not** available in the microdata files due to
+reidentification concerns. However, contingency tables that aggregate by race
+and other demographic variables [are available](contingency-tables.md).
+
 ## Wave 1
 
 Wave 1 was first deployed on April 6, 2020. This was replaced by Wave 2, but
@@ -504,8 +509,8 @@ as well as
 * Vietnamese
 
 Files:
-* [Survey text and coding](waves/CMU Survey Wave 8.pdf) (PDF)
-* [Survey text and coding](waves/CMU Survey Wave 8.docx) (Word)
+* [Survey text and coding](waves/CMU Survey Wave 10.pdf) (PDF)
+* [Survey text and coding](waves/CMU Survey Wave 10.docx) (Word)
 
 ### Summary of Changes
 

docs/symptom-survey/collaboration-revision.md

@@ -12,22 +12,7 @@ pandemic. We conduct revisions in collaboration with data users, fellow
 researchers, and public health officials, to ensure the survey data best serves
 public health and research goals.
 
-### Current Data Use Survey
-
-To allow us to better collaborate with our academic and non-profit research
-partners, we ask that you complete [this short
-checklist](http://cmu.ca1.qualtrics.com/jfe/form/SV_dnSQYuQZDkQhJ3f) of the
-questions currently on the CMU Delphi US symptom survey. This inquiry only needs
-to be completed by one member of your project team. You can complete it again at
-any time there are variables from this survey you'd like to add to your project.
-
-This will allow us to update you of any upcoming plans for revisions or change
-to the current variables, prioritize the questions that are currently in use,
-alleviate some response burden by eliminating unused questions, and allow us to
-connect with current data users regarding their research interests and areas of
-expertise.
-
-### Proposing Revisions
+## Proposing Revisions
 
 If there is a revision or question you would like us to consider, please fill
 out [this form requesting details about your

docs/symptom-survey/contingency-tables.md

@@ -22,6 +22,9 @@ for the survey is available, but only to academic or nonprofit researchers who
 sign a Data Use Agreement, whereas these contingency tables are available to the
 general public.
 
+Please see our survey [credits](index.md#credits) and [citation information](index.md#citing-the-survey)
+for information on how to cite this data if you use it in a publication.
+
 Important updates for data users, including corrections to data or updates on
 data processing delays, are posted as `OUTAGES.txt` in the directory where the
 data is hosted.
@@ -45,7 +48,7 @@ lower missingness when grouping by several features at a time.
 The included files provide estimates for various metrics of interest over a
 period of either a full epiweek (or [MMWR
 week](https://wwwn.cdc.gov/nndss/document/MMWR_week_overview.pdf), a
-standardized numbering of weeks throughout the year) or a full month.
+standardized numbering of weeks throughout the year) or a full calendar month.
 
 ## Aggregation
 
@@ -94,6 +97,10 @@ The files contain [weighted estimates](../api/covidcast-signals/fb-survey.md#sur
 respondents who fulfill one or several criteria. Estimates are broken out by
 state, age, gender, race, and ethnicity.
 
+We plan to expand this list of indicators based on research needs; if you have a
+public health or research need for a particular variable not listed here, please
+contact us at <delphi-survey-info@lists.andrew.cmu.edu>.
+
 | Indicator | Description | Survey Item |
 | --- | --- | --- |
 | `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

@@ -12,6 +12,11 @@ spread of COVID-19 and its effects on public health and well-being. This may
 help improve our local and national responses to the pandemic and our
 understanding of how it has affected society.
 
+[High-level aggregates](../api/covidcast.md) of select survey items are
+publicly available in the [COVIDcast API](../api/covidcast-signals/fb-survey.md).
+[Finer aggregates](./contingency-tables.md) grouped by various demographic
+characteristics are available for download.
+
 De-identified individual survey responses can be made available to researchers associated with
 universities or non-profit organizations. To request access to the data please
 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
 is conducted by the University of Maryland (UMD) and access can be requested
 through the same form.
 
-[High-level aggregates](../api/covidcast.md) of select survey items are
-publicly available in the [COVIDcast API](../api/covidcast-signals/fb-survey.md).
-[Finer aggregates](./contingency-tables.md) grouped by various demographic
-characteristics are available for download.
+After completing the form, staff from Facebook and CMU will be in contact to
+guide you through the rest of the process. They will provide data use agreements
+for your institution to sign, and will also request a copy of your Institutional
+Review Board approval to verify you have ethical approval to conduct the
+research. If you have questions about the process, or your IRB needs information
+about the survey for their review, contact us at
+<delphi-survey-info@lists.andrew.cmu.edu>.

docs/symptom-survey/index.md

@@ -59,7 +59,7 @@ the survey in publications based on the data. Specifically, we ask that you:
 2. Cite this web page for details about the survey. For example, you may cite it
    as
 
-    > Delphi Group (2020). COVID Symptom Survey.
+    > Delphi Group (2021). COVID Symptom Survey.
     > <https://cmu-delphi.github.io/delphi-epidata/symptom-survey/>
 
     A journal article describing the survey and its methods is currently in

docs/symptom-survey/problems.md

@@ -5,7 +5,7 @@ nav_order: 7
 ---
 
 # Problems and Data Errors
-{: no_toc}
+{: .no_toc}
 
 Given the scale of the COVID Symptom Survey, we occasionally encounter data
 errors or survey implementation problems that affect the interpretation of