Template README
Template instrument README
This is the template instrument README provided in data release documentation. Bracketed text shows what each field should contain.
[Instrument Name]
[Full name of instrument (Acronym)]
Responsible Use Warning (optional, but strongly recommended)
Documents considerations for responsible research use, interpretation, and communication of findings, e.g. conceptual limitations, sensitive variables, stigmatizing language, and/or populations or analyses for which this instrument requires additional caution or may be inappropriate.
Data Warning (optional, but strongly recommended)
Provides technical guidance and recommendations to foster reproducible research, e.g. known data quality or other issues, instructions for analyzing specific variables, and/or recommended utilities or externally provided code.
About#
Description of the instrument for other scientists/users of the data, including its purpose, constructs measured, and relevant background, providing enough context for a naive reader to understand the instrument and its significance within the study.
Study modifications
If applicable, describes modifications made to the instrument for UCSF, including any changes in response options, item wording, or administration procedures, clarifying how the UCSF version differs from the original instrument.
Administration
| Administration type | {Direct Assessment, Clinician Ratings, Parent Interview, Parent Survey, Other} |
|---|---|
| Administration setting | {Remote, In-Person, Other} |
| Duration | e.g., 10 minutes |
| Respondent | {Child, Parent, Other Caregiver, Teacher, Clinician, Other} |
| Visits | {V01, V02, etc.} |
| Validated age range | Preserve the publisher's exact wording (e.g. "3 months minus 1 day to 15 months minus 1 day") |
| Spanish translation | {Available, Not available} |
| Clinical alert criteria | If applicable, describe the criteria that trigger a clinical alert (e.g., "Summary score > 7 or Item 1 or 5 > 1") |
| Return of results | If applicable, describe which results are returned to participants or families and under what circumstances |
Scoring procedures
| Total items | # |
|---|---|
| Scale | e.g. 0-3 (4-point Likert) |
| Score types | e.g. Total score (max = #) |
| Reverse-scored items | e.g., 001, 004 |
| Non-scored items | e.g., 006 |
| Branching logic | N/A |
| Cutoff | N/A |
| Missingness | e.g. If incomplete, apply prorated scoring: {FORMULA} |
Quality Control#
High-level description of all quality control performed (e.g. checks for missingness, scoring verification, review of response distributions, outlier detection, data consistency checks, etc.).
Resources#
Direct link to the instrument's own form/manual.
References#
All key instrument references, including any papers cited within the page.