Skip to content

Commit 442dcf2

Browse files
Clarify field descriptions
Co-authored-by: Alex Reinhart <[email protected]>
1 parent 2ece345 commit 442dcf2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

docs/symptom-survey/coding.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,10 @@ Coding details for each survey wave follow.
6363

6464
The [codebook](codebook.csv) describes availability of metadata and question
6565
fields by survey version. A row is included for each field available in the
66-
microdata files for a given survey wave.
66+
microdata files for a given survey wave. We recommend using the codebook as a
67+
reference while working with the survey microdata, to ensure you interpret each
68+
question and answer choice accurately even as items were revised between
69+
survey waves.
6770

6871
If a field is available for multiple waves, it is listed separately for each
6972
version. Items that were included in non-contiguous survey waves have entries
@@ -81,7 +84,7 @@ Available columns:
8184
* `description`: Brief description of the meaning of a field or survey item.
8285
* `question`: Survey item text.
8386
* `matrix_subquestion`: Subquestion text for a matrix item.
84-
* `choices`: JSON-formatted map of answer codes and response choice text.
87+
* `choices`: JSON-formatted map of answer codes and response choice text. For example, `"5": "California"` means that responses with the value 5 correspond to the respondent selecting "California".
8588
* `type`: Survey item format; one of "Matrix" (several questions with the same question stem are displayed together with the same answer choices), "Text" (free text entry), "Multiple Choice" (particpant can select only one answer choice), or "Multiselect" (respondent can select one or more answer choices).
8689
* `display_logic`: Conditions a respondent has to satisfy to be shown an item. For example, this can require a specific answer on a single previous item or a set of previous items, or that a previous item was displayed.
8790
* `response_option_randomization`: How answer choices are displayed for a given question. Answer choice order can be fixed ("none"), reversed ("scale reversal", e.g. for Likert scales) or shuffled ("randomized") between respondents.

0 commit comments

Comments
 (0)