diff --git a/mkdocs.yml b/mkdocs.yml index c81a99bc26..bcb750c56f 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,6 +18,7 @@ nav: - Intracranial Electroencephalography: modality-specific-files/intracranial-electroencephalography.md - Physiological recordings: modality-specific-files/physiological-recordings.md - Behavioral experiments (with no neural recordings): modality-specific-files/behavioral-experiments.md + - Survey data (instrument-based phenotypic): modality-specific-files/survey.md - Genetic Descriptor: modality-specific-files/genetic-descriptor.md - Positron Emission Tomography: modality-specific-files/positron-emission-tomography.md - Microscopy: modality-specific-files/microscopy.md diff --git a/src/modality-specific-files/survey.md b/src/modality-specific-files/survey.md new file mode 100644 index 0000000000..d56bbfd457 --- /dev/null +++ b/src/modality-specific-files/survey.md @@ -0,0 +1,150 @@ +# Survey data (instrument-based phenotypic) + +Survey data files contain responses collected from standardized questionnaires or +assessment instruments. +They are organized in the same subject- and session-resolved directory hierarchy +as other BIDS modalities, with one `.tsv` data file per instrument administration +and a corresponding `.json` sidecar that documents the instrument and its items. + +This representation complements the aggregated `phenotype/` tables described in +[Phenotypic and assessment data](../modality-agnostic-files/phenotypic-and-assessment-data.md). +Aggregated phenotype tables MAY be generated from subject-resolved survey data +and stored under `phenotype/`, +but the subject-resolved structure is the primary canonical form. + + +{{ MACROS___make_filename_template("raw", datatypes=["survey"]) }} + +Survey files MUST be stored in a `survey` subdirectory of the subject (and +optionally session) directory. +The `task` entity identifies the instrument (for example, `task-pss` for the +Perceived Stress Scale). +The `run` entity MAY be used when the same instrument is administered more than +once within a session. + +## Sidecar JSON (`*_survey.json`) + +Each survey `.tsv` file MUST be accompanied by a JSON sidecar. +Following the [Inheritance Principle](../common-principles.md#the-inheritance-principle), +the sidecar MAY be placed at any level of the hierarchy +(for example, at the dataset root as `task-